-
Notifications
You must be signed in to change notification settings - Fork 29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(axe-core-4.0.1): bump axe-core from 3.5.5 to 4.0.1 #366
Conversation
Bumps [axe-core](https://github.com/dequelabs/axe-core) from 3.5.5 to 4.0.1. - [Release notes](https://github.com/dequelabs/axe-core/releases) - [Changelog](https://github.com/dequelabs/axe-core/blob/develop/CHANGELOG.md) - [Commits](dequelabs/axe-core@v3.5.5...v4.0.1) Signed-off-by: dependabot-preview[bot] <[email protected]>
README.md
Outdated
@@ -66,7 +66,7 @@ The [microsoft/axe-pipelines-samples](https://github.com/microsoft/axe-pipelines | |||
|
|||
The version number of this library is **independent** from the version numbers of the axe-core inputs and SARIF outputs it supports. | |||
|
|||
- axe-sarif-converter version 2.x supports input from version ^3.2.0 of axe-core (tested with 3.2.2, 3.3.2, 3.4.1, 3.4.2, 3.5.1, 3.5.2, 3.5.3, 3.5.4, and 3.5.5) and outputs SARIF v2.1 | |||
- axe-sarif-converter version 2.x supports input from version ^3.2.0 of axe-core (tested with 3.2.2, 3.3.2, 3.4.1, 3.4.2, 3.5.1, 3.5.2, 3.5.3, 3.5.4, 3.5.5, and 4.0.1) and outputs SARIF v2.1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The part earlier in the sentence where it says ^3.2.0
should be updated too, I'd suggest "version ^3.2.0 || ^4.0.0"
package.json
Outdated
@@ -15,7 +15,7 @@ | |||
}, | |||
"dependencies": { | |||
"@types/sarif": ">=2.1.1 <=2.1.2", | |||
"axe-core": "^3.2.2", | |||
"axe-core": "^4.0.1", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We actually don't generally update this (that's why it's still back at 3.2.2), since we don't want to force users to update axe-core in order to update our library (it would have been better for us to use a peerDependency
for this, but we decided we didn't want to make a breaking change to fix it). You will want to update this to claim support for using 4.x as well as 3.x though; I think I'd suggest "^3.2.2 || ^4.0.0"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The test updates look good, a few suggestions on package.json/readme changes. Per discussion offline, I think the package.json change we'll want is going to warrant a minor version bump for the library (which means the PR title and merge commit need a feat
prefix rather than chore
🎉 This PR is included in version 2.4.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description of changes
Update axe-core from 3.5.5 to 4.0.1, following the directions from the readme
Pull request checklist
fix:
,feat:
, etc, and is suitable for user-facing release notes)BREAKING CHANGE:
yarn precheckin