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: document/test support for axe-core v3.4.1 and axe-cli v3.2.0 #175

Merged
merged 13 commits into from
Jan 7, 2020

Conversation

dbjorge
Copy link
Contributor

@dbjorge dbjorge commented Jan 7, 2020

Description of changes

Neither axe-core v3.4.1 nor axe-cli v3.2.0 contain any breaking output format changes, so axe-sarif-converter was already compatible with both of them. This PR updates our test cases to include verification of this compatibility.

This PR also checks in code to generate test cases for future axe-core updates, and documents the process for performing such an update in the README under a new subsection of Contributing.

Review suggestions:

  • Start from the README.md changes; this provides a broad understanding of the changes and the expected usage of the new generator.
  • For the files under /src/test-resources/*.{json|sarif}, review by comparing against the similar files for old axe versions to satisfy yourself that they've been generated consistently and follow the same format.
  • Review all other code per normal (particularly the new code under /src/test-resources/generator)

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:
  • [n/a] (if applicable) Addresses issue: #0000
  • Added relevant unit tests for your changes
  • Ran yarn precheckin
  • Verified code coverage for the changes made

@dbjorge dbjorge requested a review from a team as a code owner January 7, 2020 01:42
Copy link

@smoralesd smoralesd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some minor comments

src/test-resources/generator/generate-axe-cli-resources.ts Outdated Show resolved Hide resolved
src/index.test.ts Outdated Show resolved Hide resolved
@dbjorge dbjorge merged commit 97f6a41 into microsoft:master Jan 7, 2020
@dbjorge dbjorge deleted the axe-core-3.4.1 branch January 7, 2020 21:31
@ada-cat
Copy link
Collaborator

ada-cat commented Jan 7, 2020

🎉 This PR is included in version 2.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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