component-driven / component-driven/cypress-axe
Feature Request: Support Non-Failing Accessibility Tests for Report-Only Mode in CI/CD
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 641
- Forks
- 90
- Avg merge
- 6h 8m
- Merged PRs (30d)
- 1
Description
I have a use case where I'm running accessibility checks across multiple pages and collecting the violation data to build a report. The goal is to generate insights.
it("Accessibility test for page", () => {
const pageName = "Some Page";
cy.visit("/some-page");
cy.injectAxe();
cy.checkA11y(null, { failOnError: false }, (violations) => {
cy.task("saveA11yViolations", { pageName, violations });
});
});
The cy.task("saveA11yViolations") function stores violations in a JSON file to later build an accessibility report.
Problem in CI/CD
When I run this in a CI/CD pipeline, the test sometimes fails, which causes:
- The job to stop prematurely
- Artifacts (like the report JSON) to never be uploaded
- The entire pipeline to fail, even though the goal was just data collection
Can we add an official mode or configuration for use cases like this — where:
- The test is used only to gather and log violations
- The test should never fail, even if violations are found
- The pipeline should continue, ensuring logs and artifacts are always available
Or could you please let me know if something like this already exists and I’m just missing it?
Environment
cypress: 14.0.0
cypress-axe: 1.6.0
CI Platform: GitLab CI/CD
Thanks,
Hit
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the cy.checkA11y entry point and review how the shown failOnError: false option behaves in CI/CD. Check whether an existing configuration already supports report-only collection, then define the expected behavior for saved violations, test completion, and artifact availability.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cypress, typescript
- Domain
- accessibility, ci-cd, testing-qa
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100