Integrate GitHub with Your Project (Enterprise Only)
The GitHub integration in A11yNow allows you to connect accessibility workflows directly with GitHub repositories. Once configured, A11yNow can automatically create and synchronize GitHub issues, helping development teams track, prioritize, and resolve accessibility findings within their existing development workflow. By configuring repository settings, synchronization options, status mapping, parent linking, and field mapping, you can ensure accessibility issues remain aligned between A11yNow and your GitHub repository.
Pre-requisites
Before configuring a project-level integration, ensure that GitHub has already been connected to A11yNow through the organization settings.
Connect GitHub to a Project
To connect GitHub on A11yInspect with your project:
- Sign in to BarrierBreak A11yNow.
- Go to Projects module.
- Open the project you want to configure.
- Go to Integrations tab.
- Select Connect option under GitHub. You will now redirect to configure the required integration settings.
Configure GitHub Integration Setting
After connecting the GitHub, configure the required integration settings by proceeding with following steps:
Step 1: Select a Repository
Under the details, select a Repository from the dropdown list. The selected repository will be used for creating and managing GitHub issues exported from the A11yNow projects.
Step 2: Configure Sinc Options
Choose any option to sync BarrierBreak A11yNow with GitHub. Refer the following table to understand the options:
- Auto Sync: Automatically synchronizes updates between A11yNow and GitHub Issues.
- Auto-create Issues: Automatically creates GitHub Issues for newly identified accessibility findings.
Step 3: Configure Parent Linking
Choose any option to configure the parent linking as follows:
- No Parent: The issues will be created in GitHub without parent issues.
- Choose During Sync: It will allow you to select the parent issue while manually syncing to GitHub.
- Default Parent: Select a parent issue from dropdown field. All the issues will sync under that selected parent issue.
Step 4: Configure Status Mapping
Map A11yInspect issue status with the corresponding GitHub issue statuses as follows:
| A11yNow Issue Status | GitHub Issue Status |
|---|---|
| To Do | Open |
| In Progress | Open |
| Done | Close |
Step 5: Field Mapping
Map accessibility finding details to GitHub issue fields to ensure all relevant information is synced correctly during issue creation. Field mappings can be customized based on your repository requirements. Refer to the table below to fields values:
| A11yNow Fields | GitHub Fields (Default) |
|---|---|
| Issue | Title |
| Type | Labels |
| Severity | Labels |
| Success Criteria | Description |
| Conformance Level | Description |
| Element | Description |
| Attribute | Description |
| Actual Result | Description |
| Expected Result | Description |
| Recommendation | Description |
| Step To Validate | Description |
| Existing Code | Description |
Step 6: Save the Configurations
- Review all the configured settings
- Select Submit to save the configuration. All the configured integration details will be displayed on the project integration dashboard. You can edit configurations anytime.
Edit the Existing GitHub Integration Settings
Based on your requirements, you can edit configurations anytime.
To edit the integration settings:
- Sign in to BarrierBreak A11yNow.
- Go to Projects.
- Open the project you want to edit.
- Go to Integration tab.
- Select View Integration option under GitHub.
- Select on Edit in the upper- right corner.
- Update the required configuration options.
- Select on Submit to save changes.
Disconnect GitHub Integrations
To disconnect GitHub integration:
- Go to BarrierBreak A11yNow.
- Go to Projects.
- Open the project you want to edit.
- Go to Integration tab.
- Select View Integration option under GitHub.
- Select Unlink GitHub.
Now your GitHub is unlinked with BarrierBreak A11yNow.
note
- You must connect GitHub in Settings before it can be linked to individual projects.