Update issue fetching in GHES release notes generator (#61926)

Author: sarahs

src/ghes-releases/lib/release-issues.ts

@@ -0,0 +1,52 @@
+export type IssueState = 'open' | 'closed' | 'all'
+
+const VALID_ISSUE_STATES: IssueState[] = ['open', 'closed', 'all']
+const EXCLUDED_RELEASE_LABELS = new Set(['public roadmap', 'not planned'])
+
+interface IssueLike {
+  labels: { name: string }[]
+}
+
+/**
+ * Parse and validate the issue state filter. Defaults to "all".
+ */
+export function parseIssueState(value?: string): IssueState {
+  if (!value) return 'all'
+
+  const normalized = value.toLowerCase()
+  if (VALID_ISSUE_STATES.includes(normalized as IssueState)) {
+    return normalized as IssueState
+  }
+
+  throw new Error(
+    `Invalid issue state "${value}". Expected one of: ${VALID_ISSUE_STATES.join(', ')}`,
+  )
+}
+
+/**
+ * Build gh CLI args for listing release issues.
+ */
+export function buildReleaseIssueListArgs(version: string, issueState: IssueState): string[] {
+  const label = `GHES ${version}`
+  return [
+    'issue',
+    'list',
+    '--repo',
+    'github/releases',
+    '--label',
+    label,
+    '--state',
+    issueState,
+    '--limit',
+    '200',
+    '--json',
+    'number,title,url,body,labels',
+  ]
+}
+
+/**
+ * Excludes release issues that should not produce GHES release notes.
+ */
+export function isExcludedReleaseIssue(issue: IssueLike): boolean {
+  return issue.labels.some((l) => EXCLUDED_RELEASE_LABELS.has(l.name.toLowerCase()))
+}

src/ghes-releases/scripts/generate-release-notes.ts

@@ -3,7 +3,7 @@
  * @description Generate GHES release notes from github/releases issues using Copilot CLI
  *
  * Generate GHES release notes by:
- * 1. Querying github/releases for open issues labeled "GHES <version>"
+ * 1. Querying github/releases issues labeled "GHES <version>" (all states by default)
  * 2. Finding corresponding changelog PRs in github/blog
  * 3. Running each through the ghes-release-notes agent via Copilot CLI
  * 4. Stitching the YAML outputs into a release notes file
@@ -25,6 +25,12 @@ import {
   buildReleaseNotesYaml,
   appendNoteLines,
 } from '@/ghes-releases/lib/parse-release-notes'
+import {
+  type IssueState,
+  buildReleaseIssueListArgs,
+  isExcludedReleaseIssue,
+  parseIssueState,
+} from '@/ghes-releases/lib/release-issues'
 
 // ─── Ctrl+C handling ─────────────────────────────────────────────────────────
 // Copilot CLI puts the terminal in raw mode, so we catch Ctrl+C (0x03) manually.
@@ -94,25 +100,12 @@ function gh(args: string[]): string {
 }
 
 /**
- * Fetch open release issues labeled "GHES <version>"
+ * Fetch release issues labeled "GHES <version>" using the selected issue state.
  */
-function fetchReleaseIssues(version: string): ReleaseIssue[] {
-  const label = `GHES ${version}`
-  const output = gh([
-    'issue',
-    'list',
-    '--repo',
-    'github/releases',
-    '--label',
-    label,
-    '--state',
-    'open',
-    '--limit',
-    '200',
-    '--json',
-    'number,title,url,body,labels',
-  ])
-  return JSON.parse(output) as ReleaseIssue[]
+function fetchReleaseIssues(version: string, issueState: IssueState): ReleaseIssue[] {
+  const output = gh(buildReleaseIssueListArgs(version, issueState))
+  const issues = JSON.parse(output) as ReleaseIssue[]
+  return issues.filter((issue) => !isExcludedReleaseIssue(issue))
 }
 
 interface ChangelogInfo {
@@ -484,6 +477,11 @@ program
     return true
   })
   .option('--stdout', 'Print output to console instead of writing to file')
+  .option(
+    '--issue-state <state>',
+    'Issue state filter for github/releases issues (open, closed, all). Defaults to all.',
+    'all',
+  )
   .option(
     '-i, --issue <value>',
     'Process a single issue by number or URL (replaces its entry if it already exists)',
@@ -507,12 +505,20 @@ program
       release: string
       rc: boolean
       stdout?: boolean
+      issueState?: string
       issue?: number
       force?: boolean
     }) => {
       const { release, stdout, issue: singleIssue, force } = options
       const rc = options.rc ?? false
       const spinner = ora()
+      let issueState: IssueState
+      try {
+        issueState = parseIssueState(options.issueState)
+      } catch (error) {
+        console.error(`Error: ${(error as Error).message}`)
+        process.exit(1)
+      }
 
       // ── Prerequisite checks ──
       try {
@@ -560,17 +566,25 @@ program
             'number,title,url,body,labels',
           ])
           const issue = JSON.parse(output) as ReleaseIssue
+          if (isExcludedReleaseIssue(issue)) {
+            spinner.fail(
+              `Issue #${singleIssue} is excluded by label (public roadmap or not planned).`,
+            )
+            process.exit(0)
+          }
           issues = [issue]
           spinner.succeed(`Fetched issue #${singleIssue}: ${issue.title}`)
         } catch (error) {
           spinner.fail(`Failed to fetch issue #${singleIssue}: ${(error as Error).message}`)
           process.exit(1)
         }
       } else {
-        spinner.start(`Fetching open issues labeled "GHES ${release}"...`)
+        spinner.start(`Fetching issues labeled "GHES ${release}" (state: ${issueState})...`)
         try {
-          issues = fetchReleaseIssues(release)
-          spinner.succeed(`Found ${issues.length} open issues labeled "GHES ${release}"`)
+          issues = fetchReleaseIssues(release, issueState)
+          spinner.succeed(
+            `Found ${issues.length} issues labeled "GHES ${release}" (state: ${issueState})`,
+          )
         } catch (error) {
           spinner.fail(`Failed to fetch issues: ${(error as Error).message}`)
           process.exit(1)

src/ghes-releases/tests/release-issues.ts

@@ -0,0 +1,59 @@
+import { describe, expect, test } from 'vitest'
+
+import {
+  buildReleaseIssueListArgs,
+  isExcludedReleaseIssue,
+  parseIssueState,
+  type IssueState,
+} from '@/ghes-releases/lib/release-issues'
+
+describe('parseIssueState', () => {
+  test('defaults to all when not provided', () => {
+    expect(parseIssueState()).toBe('all')
+  })
+
+  test('accepts valid values case-insensitively', () => {
+    expect(parseIssueState('OPEN')).toBe('open')
+    expect(parseIssueState('closed')).toBe('closed')
+    expect(parseIssueState('All')).toBe('all')
+  })
+
+  test('throws on invalid values', () => {
+    expect(() => parseIssueState('anything-else')).toThrow('Invalid issue state')
+  })
+})
+
+describe('buildReleaseIssueListArgs', () => {
+  test('builds gh issue list args with release label and state', () => {
+    const args = buildReleaseIssueListArgs('3.20', 'closed' satisfies IssueState)
+
+    expect(args).toEqual([
+      'issue',
+      'list',
+      '--repo',
+      'github/releases',
+      '--label',
+      'GHES 3.20',
+      '--state',
+      'closed',
+      '--limit',
+      '200',
+      '--json',
+      'number,title,url,body,labels',
+    ])
+  })
+})
+
+describe('isExcludedReleaseIssue', () => {
+  test('returns true for public roadmap label', () => {
+    expect(isExcludedReleaseIssue({ labels: [{ name: 'public roadmap' }] })).toBe(true)
+  })
+
+  test('returns true for not planned label (case-insensitive)', () => {
+    expect(isExcludedReleaseIssue({ labels: [{ name: 'Not Planned' }] })).toBe(true)
+  })
+
+  test('returns false when no excluded labels are present', () => {
+    expect(isExcludedReleaseIssue({ labels: [{ name: 'GHES 3.20' }, { name: 'bug' }] })).toBe(false)
+  })
+})