From e31cdd432e46bd0848774e1783e2b124f77c40e1 Mon Sep 17 00:00:00 2001 From: marktnoonan Date: Wed, 30 Oct 2024 10:28:06 -0400 Subject: [PATCH 1/3] add axe-core update policy --- docs/accessibility/changelog.mdx | 4 ++++ docs/accessibility/core-concepts/how-it-works.mdx | 12 ++++++++++++ 2 files changed, 16 insertions(+) diff --git a/docs/accessibility/changelog.mdx b/docs/accessibility/changelog.mdx index c8cd171f8e..83e08d4da6 100644 --- a/docs/accessibility/changelog.mdx +++ b/docs/accessibility/changelog.mdx @@ -7,6 +7,10 @@ sidebar_position: 200 # Changelog +## Week of 10/28/2024 + +- Our [Axe Core® versioning policy](/accessibility/core-concepts/how-it-works) has been published, providing a 30-day buffer between any Axe Core® releases and the adoption of those releases in Cypress Cloud. + ## Week of 9/30/2024 - Cypress Accessibility results are now included in Slack messages alongside test results. [Learn more about our Slack integration here](https://on.cypress.io/slack-integration). diff --git a/docs/accessibility/core-concepts/how-it-works.mdx b/docs/accessibility/core-concepts/how-it-works.mdx index 8340cb6231..db54d5eed2 100644 --- a/docs/accessibility/core-concepts/how-it-works.mdx +++ b/docs/accessibility/core-concepts/how-it-works.mdx @@ -29,6 +29,18 @@ This means that a 100% axe score does not mean all possible accessibility errors The value of this form of testing in Cypress Accessibility is to give you fast, reliable, easy-to-understand feedback about common accessibility mistakes that are found in most projects. Providing these results automatically as part of your test run means that you can find and fix these issues with minimal friction, shifting accessibility left in your software development lifecycle. +## Axe Core® updates + +Axe Core® publishes new versions several times a year. Cypress will wait at least 30 days after an Axe Core® release before updating the library used in the Cloud. This gives you a known minimum amount of time to see the [changelog](https://github.com/dequelabs/axe-core/blob/develop/CHANGELOG.md) and make any necessary adjustments to your process in advance of Cypress Cloud bumping the version. Bug fixes or new rules in Axe Core® may cause previously-passing projects to fail. + +We will strive to update Axe Core® in a timely manner after that 30-day buffer, but set no specific expectation around when that will be. Each release is different, and some do not affect the way Axe Core® is executed in Cypress Cloud at all, so those releases may be skipped. + +### Exceptions + +In rare cases - such as if an Axe Core® update contains a critical security patch - we may need to update sooner than the 30-day window. If this happens we will communicate with affected customers. + +The [Cypress Accessibility changelog](/accessibility/changelog) will reflect any Axe Core® updates that are made in Cypress Cloud, starting on December 1, 2025 (30 days after the publication of this policy). + ## Powered by Test Replay Because Cypress Accessibility uses data captured through Cypress Test Replay, it is subject [Test Replay limitations](https://docs.cypress.io/faq/questions/cloud-faq#Is-everything-captured-and-replayed-in-Test-Replay). From 91e2b51dd1fa9dce58d1760c7efd9948ffe321d2 Mon Sep 17 00:00:00 2001 From: marktnoonan Date: Wed, 30 Oct 2024 10:30:35 -0400 Subject: [PATCH 2/3] reorganize --- docs/accessibility/core-concepts/how-it-works.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/accessibility/core-concepts/how-it-works.mdx b/docs/accessibility/core-concepts/how-it-works.mdx index db54d5eed2..d24b2d2b07 100644 --- a/docs/accessibility/core-concepts/how-it-works.mdx +++ b/docs/accessibility/core-concepts/how-it-works.mdx @@ -35,12 +35,12 @@ Axe Core® publishes new versions several times a year. Cypress will wait at lea We will strive to update Axe Core® in a timely manner after that 30-day buffer, but set no specific expectation around when that will be. Each release is different, and some do not affect the way Axe Core® is executed in Cypress Cloud at all, so those releases may be skipped. +The [Cypress Accessibility changelog](/accessibility/changelog) will reflect any Axe Core® updates that are made in Cypress Cloud, starting on December 1, 2025 (30 days after the publication of this policy). + ### Exceptions In rare cases - such as if an Axe Core® update contains a critical security patch - we may need to update sooner than the 30-day window. If this happens we will communicate with affected customers. -The [Cypress Accessibility changelog](/accessibility/changelog) will reflect any Axe Core® updates that are made in Cypress Cloud, starting on December 1, 2025 (30 days after the publication of this policy). - ## Powered by Test Replay Because Cypress Accessibility uses data captured through Cypress Test Replay, it is subject [Test Replay limitations](https://docs.cypress.io/faq/questions/cloud-faq#Is-everything-captured-and-replayed-in-Test-Replay). From 49b67bcb6e0d1e58efc03ab448e0d0043c7420c0 Mon Sep 17 00:00:00 2001 From: marktnoonan Date: Wed, 30 Oct 2024 10:31:08 -0400 Subject: [PATCH 3/3] more specific link --- docs/accessibility/changelog.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/accessibility/changelog.mdx b/docs/accessibility/changelog.mdx index 83e08d4da6..3c56015ac6 100644 --- a/docs/accessibility/changelog.mdx +++ b/docs/accessibility/changelog.mdx @@ -9,7 +9,7 @@ sidebar_position: 200 ## Week of 10/28/2024 -- Our [Axe Core® versioning policy](/accessibility/core-concepts/how-it-works) has been published, providing a 30-day buffer between any Axe Core® releases and the adoption of those releases in Cypress Cloud. +- Our [Axe Core® versioning policy](/accessibility/core-concepts/how-it-works#Axe-Core-updates) has been published, providing a 30-day buffer between any Axe Core® releases and the adoption of those releases in Cypress Cloud. ## Week of 9/30/2024