Skip to content
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

Merged
merged 6 commits into from
Aug 11, 2020

Conversation

DaveTryon
Copy link
Contributor

Description of changes

Update axe-core from 3.5.5 to 4.0.1, following the directions from the readme

Pull request checklist

  • PR title respects Conventional Commits (starts with fix:, feat:, etc, and is suitable for user-facing release notes)
  • PR contains no breaking changes, OR description of both PR and final merge commit starts with BREAKING CHANGE:
  • (if applicable) Addresses issue: 1758928
  • Added relevant unit tests for your changes
  • Ran yarn precheckin
  • Verified code coverage for the changes made

@DaveTryon DaveTryon requested a review from a team as a code owner August 10, 2020 23:56
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
Copy link
Contributor

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",
Copy link
Contributor

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"

Copy link
Contributor

@dbjorge dbjorge left a 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

@DaveTryon DaveTryon changed the title chore(axe-core-4.0.1): bump axe-core from 3.5.5 to 4.0.1 feat(axe-core-4.0.1): bump axe-core from 3.5.5 to 4.0.1 Aug 11, 2020
@DaveTryon DaveTryon merged commit 7fa836b into master Aug 11, 2020
@ada-cat
Copy link
Collaborator

ada-cat commented Aug 11, 2020

🎉 This PR is included in version 2.4.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@dbjorge dbjorge deleted the AxeCore_4.0.1 branch February 26, 2021 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants