diff options
Diffstat (limited to '.github')
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug.yml | 6 | ||||
| -rw-r--r-- | .github/workflows/issue-gate.yml | 55 |
2 files changed, 57 insertions, 4 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 6cefded4..330541d2 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -12,6 +12,8 @@ body: Keep this short. If it does not fit on one screen, it is too long. Write in your own voice. + Use only the sections in this template. Do not add root cause, proposed fix, analysis, implementation plan, or similar sections unless a maintainer asks. + - type: checkboxes id: bug-confirmation attributes: @@ -25,7 +27,7 @@ body: id: current-behavior attributes: label: Current behavior - description: What is happening now? + description: What is happening now? Describe what you observed, not a guessed cause. validations: required: true @@ -41,7 +43,7 @@ body: id: reproduction attributes: label: Reproduction - description: What are the shortest steps that show the problem? + description: What are the shortest exact steps or commands that show the problem? validations: required: true diff --git a/.github/workflows/issue-gate.yml b/.github/workflows/issue-gate.yml index fdeaea46..67bd3778 100644 --- a/.github/workflows/issue-gate.yml +++ b/.github/workflows/issue-gate.yml @@ -32,6 +32,7 @@ jobs: ]; const requiredEnvironmentFields = [ /^\s*(?:-\s*)?Herdr version:[^\S\r\n]*\S.*$/m, + /^\s*(?:-\s*)?Update channel(?: \(stable or preview\))?:[^\S\r\n]*(?:stable|preview)\b.*$/im, /^\s*(?:-\s*)?Operating system:[^\S\r\n]*\S.*$/m, /^\s*(?:-\s*)?Terminal:[^\S\r\n]*\S.*$/m, ]; @@ -66,6 +67,20 @@ jobs: return typeof section === 'string' && section.trim().length > 0; } + function bodyWithoutFencedCodeBlocks(value) { + let inFence = false; + return value + .split(/\r?\n/) + .filter((line) => { + if (/^\s{0,3}(```|~~~)/.test(line)) { + inFence = !inFence; + return false; + } + return !inFence; + }) + .join('\n'); + } + async function getPermission(username) { try { const { data: permissionLevel } = await github.rest.repos.getCollaboratorPermissionLevel({ @@ -95,6 +110,10 @@ jobs: const body = issue.body || ''; const hasBugConfirmation = bugConfirmationPattern.test(body); const hasBugTemplate = requiredSections.every((section) => body.includes(section)); + const allowedHeadings = new Set(requiredSections); + const headingBody = bodyWithoutFencedCodeBlocks(body); + const headings = [...headingBody.matchAll(/^\s{0,3}#{1,6}\s+(.+?)\s*$/gm)].map((match) => match[0].trim()); + const extraHeadings = headings.filter((heading) => !allowedHeadings.has(heading)); const currentBehavior = extractSection(body, '### Current behavior'); const expectedBehavior = extractSection(body, '### Expected behavior'); const reproduction = extractSection(body, '### Reproduction'); @@ -107,6 +126,38 @@ jobs: impact, ].every(hasContent); const hasEnvironmentFields = hasContent(environment) && requiredEnvironmentFields.every((pattern) => pattern.test(environment)); + if (hasBugConfirmation && hasBugTemplate && extraHeadings.length > 0) { + const message = [ + `hi @${author}, thanks for opening this.`, + '', + 'this issue uses extra markdown headings outside the bug report template.', + '', + 'please use the exact template sections only. bug reports should describe observed behavior, exact reproduction steps, impact, and environment. extra root-cause analysis, proposed fixes, implementation plans, or generated diagnosis make reports harder to triage.', + ...(hasEnvironmentFields ? [] : [ + '', + 'this report is also missing required environment details: herdr version, update channel, operating system, and terminal.', + ]), + '', + 'closing this so the issue tracker stays limited to concise, actionable bug reports.', + ].join('\n'); + + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issue.number, + body: message, + }); + + await github.rest.issues.update({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issue.number, + state: 'closed', + state_reason: 'not_planned', + }); + return; + } + if (hasBugConfirmation && hasBugTemplate && hasRequiredContent && hasEnvironmentFields) { console.log(`#${issue.number} matches the bug report template`); return; @@ -116,7 +167,7 @@ jobs: const message = [ `hi @${author}, thanks for opening this.`, '', - 'this bug report is missing required environment details. please edit the issue and fill in herdr version, operating system, and terminal.', + 'this bug report is missing required environment details. please edit the issue and fill in herdr version, update channel, operating system, and terminal.', '', 'shell and relevant config are optional, but they help when they affect the bug.', ].join('\n'); @@ -137,7 +188,7 @@ jobs: '', 'this issue does not appear to use the full bug report template. herdr issues are only for reproducible bugs and maintainer-created or maintainer-converted work items.', '', - 'bug reports must include the reproducible-bug confirmation, current behavior, expected behavior, reproduction, impact, and environment fields with herdr version, operating system, and terminal.', + 'bug reports must include the reproducible-bug confirmation, current behavior, expected behavior, reproduction, impact, and environment fields with herdr version, update channel, operating system, and terminal.', '', 'feature requests, ideas, questions, contribution proposals, and direction checks belong in discussions:', `https://github.com/${context.repo.owner}/${context.repo.repo}/discussions`, |