-
Notifications
You must be signed in to change notification settings - Fork 0
Labels
enhancementNew feature or requestNew feature or request
Description
Description
Create a reusable GitHub Actions workflow template that runs automated accessibility testing using LensCore on web-based projects. The template should support multiple deployment strategies (Vercel, Next.js local build, and custom npm projects) and provide clear feedback on accessibility issues found during scans.
User Story
As a developer on the team, I want a GitHub CI template that automatically scans my web projects for accessibility issues so that I can catch and fix accessibility problems before they reach production.
Acceptance Criteria
- GitHub Actions workflow file (.github/workflows/lens-core.yml) is created and functional
- Workflow supports three deployment modes:
- Vercel: Integrates with Vercel deployment to get preview URL automatically
- Next.js: Builds and starts the application locally, then scans
- Custom: Uses standard
npm run buildandnpm run startcommands
- URL to scan is configurable through workflow settings/inputs
- Workflow fails CI if LensCore finds accessibility issues
- Scan results are displayed to users in a meaningful way:
- JSON output is generated
- HTML report page is generated/displayed if possible
- Documentation includes:
- How to use the template for each deployment mode
- How to configure authentication for protected pages
- Example configurations for each mode
- Template is designed to be reusable across multiple projects (primarily for PR validation, but flexible for other triggers)
Technical Requirements
- Use LensCore CLI or Docker image for scanning
- Support GitHub Actions workflow inputs for configuration
- Handle different project types (Vercel, Next.js, generic npm projects)
- Generate actionable output (JSON + HTML report if feasible)
- Document authentication configuration options that can be passed to the CLI
- Ensure workflow can be triggered on PR events and other user-defined triggers
Additional Notes
- Reference: LensCore documentation should be consulted for CLI usage and configuration options
- The template should be flexible enough for the dev team to adapt to their specific repo needs
- Consider using GitHub Actions artifacts for storing HTML reports
- May want to explore posting results as PR comments or check annotations for better visibility
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request