@userway/cicd-core is a component of UserWay CI/CD (Continuous Accessibility) infrastructure. This library encapsulates client-side integration logic with the Continuous Accessibility backend and triggers accessibility analysis. It glues UserWay CI/CD E2E integrations (like @userway/a11y-cypress) and UserWay CI/CD backend. The primary function is to collect a11y reports generated during CI/CD pipeline execution and trigger analysis via the UserWay CI/CD API. @userway/cicd-core exposes API and is used by multiple Continuous Accessibility extensions:
- UserWay CI/CD CLI
- UserWay GitHub action
- UserWay Bitbucket pipe
- UserWay Azure DevOps extension
- UserWay GitLab Docker Image
It is recommended that one of those extensions be used in most cases, but developers can install and use @userway/cicd-core directly to trigger Continuous Accessibility analysis programmatically.
npm install --save-dev @userway/cicd-core
import { scan } from '@userway/cicd-core';
const scanResult: Scan = await scan({
organization: 'YOUR-CICD-ORGANIZATION-SLUG',
project: 'YOUR-CICD-PROJECT-NAME',
token: 'YOUR-CICD-PROJECT-TOKEN',
reportPaths: ['./uw-a11y-reports']
});