Surface finding category in issue body and label

Author: kzhou314

.github/actions/file/src/generateIssueBody.ts

@@ -18,13 +18,20 @@ export function generateIssueBody(finding: Finding, screenshotRepo: string): str
 `
   }
 
+  const categoryNotice =
+    finding.category && finding.category !== 'wcag'
+      ? `**Note:** This is ${
+          finding.category === 'experimental' ? 'an experimental check' : 'a best-practice recommendation'
+        }, not a hard WCAG failure.\n\n`
+      : ''
+
   const acceptanceCriteria = `## Acceptance Criteria
 - [ ] The specific violation reported in this issue is no longer reproducible.
 - [ ] The fix MUST meet WCAG 2.1 guidelines OR the accessibility standards specified by the repository or organization.
 - [ ] A test SHOULD be added to ensure this specific violation does not regress.
 - [ ] This PR MUST NOT introduce any new accessibility issues or regressions.`
 
-  const body = `## What
+  const body = `${categoryNotice}## What
 An accessibility scan ${finding.html ? `flagged the element \`${finding.html}\`` : `found an issue on ${finding.url}`} because ${finding.problemShort}. Learn more about why this was flagged by visiting ${finding.problemUrl}.
 
 ${screenshotSection ?? ''}

.github/actions/file/src/openIssue.ts

@@ -26,6 +26,10 @@ export async function openIssue(octokit: Octokit, repoWithOwner: string, finding
   if (finding.ruleId) {
     labels.push(`${finding.scannerType} rule: ${finding.ruleId}`)
   }
+  // Flag non-WCAG findings so they can be filtered or triaged separately
+  if (finding.category && finding.category !== 'wcag') {
+    labels.push(finding.category)
+  }
 
   const title = truncateWithEllipsis(
     `Accessibility issue: ${finding.problemShort[0].toUpperCase() + finding.problemShort.slice(1)} on ${new URL(finding.url).pathname}`,

.github/actions/file/src/types.d.ts

@@ -1,5 +1,8 @@
+export type FindingCategory = 'wcag' | 'best-practice' | 'experimental'
+
 export type Finding = {
   scannerType: string
+  category?: FindingCategory
   ruleId?: string
   url: string
   html?: string

.github/actions/file/tests/generateIssueBody.test.ts

@@ -76,4 +76,27 @@ describe('generateIssueBody', () => {
     expect(body).toContain(`found an issue on ${findingWithEmptyOptionalFields.url}`)
     expect(body).not.toContain('flagged the element')
   })
+
+  it('omits the category notice for WCAG findings', () => {
+    expect(generateIssueBody(baseFinding, 'github/accessibility-scanner')).not.toContain('**Note:**')
+    expect(generateIssueBody({...baseFinding, category: 'wcag'}, 'github/accessibility-scanner')).not.toContain(
+      '**Note:**',
+    )
+  })
+
+  it('includes a best-practice notice for best-practice findings', () => {
+    const body = generateIssueBody({...baseFinding, category: 'best-practice'}, 'github/accessibility-scanner')
+
+    expect(body).toContain('**Note:**')
+    expect(body).toContain('best-practice recommendation')
+    expect(body).toContain('not a hard WCAG failure')
+  })
+
+  it('includes an experimental notice for experimental findings', () => {
+    const body = generateIssueBody({...baseFinding, category: 'experimental'}, 'github/accessibility-scanner')
+
+    expect(body).toContain('**Note:**')
+    expect(body).toContain('an experimental check')
+    expect(body).toContain('not a hard WCAG failure')
+  })
 })

.github/actions/file/tests/openIssue.test.ts

@@ -65,6 +65,28 @@ describe('openIssue', () => {
     )
   })
 
+  it('adds a category label for non-WCAG findings', async () => {
+    const octokit = mockOctokit()
+    await openIssue(octokit, 'org/repo', {...baseFinding, category: 'best-practice'})
+
+    expect(octokit.request).toHaveBeenCalledWith(
+      expect.any(String),
+      expect.objectContaining({
+        labels: ['axe-scanning-issue', 'axe rule: color-contrast', 'best-practice'],
+      }),
+    )
+  })
+
+  it('does not add a category label for WCAG findings', async () => {
+    const octokit = mockOctokit()
+    await openIssue(octokit, 'org/repo', {...baseFinding, category: 'wcag'})
+
+    const labels = octokit.request.mock.calls[0][1].labels
+    expect(labels).not.toContain('wcag')
+    expect(labels).not.toContain('best-practice')
+    expect(labels).not.toContain('experimental')
+  })
+
   it('truncates long titles with ellipsis', async () => {
     const octokit = mockOctokit()
     const longFinding = {