-
-
Notifications
You must be signed in to change notification settings - Fork 26
Add Danger configuration and enforce PR description template #111
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kpj2006
wants to merge
2
commits into
AOSSIE-Org:main
Choose a base branch
from
kpj2006:pach-8
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| name: PR Template Validation | ||
|
|
||
| # pull_request_target is used (instead of pull_request) so that GITHUB_TOKEN | ||
| # has write permissions even for PRs from forks, which is required for Danger | ||
| # to post review comments. The Dangerfile is always read from the base branch | ||
| # (checked out below), so no untrusted code from the fork is executed. | ||
| on: | ||
| pull_request_target: | ||
| types: [opened, edited, reopened, synchronize] | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
| issues: write | ||
|
|
||
| jobs: | ||
| danger: | ||
| if: ${{ github.repository_owner == 'AOSSIE-Org' }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout base branch | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "20" | ||
|
|
||
| - name: Run Danger JS | ||
| run: npx --yes danger@13.0.7 ci | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| // dangerfile.js — enforces the PR description template | ||
| // Docs: https://danger.systems/js/ | ||
| const body = danger.github.pr.body || ""; | ||
| const normalizedBody = body.replace(/\r\n/g, "\n"); | ||
|
|
||
| const issues = []; | ||
|
|
||
| function escapeRegex(value) { | ||
| return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); | ||
| } | ||
|
|
||
| function hasCheckedChecklistItem(itemText) { | ||
| const escapedItem = escapeRegex(itemText).replace(/\s+/g, "\\s+"); | ||
| const checkedItemPattern = new RegExp(`-\\s*\\[[xX]\\]\\s*${escapedItem}`, "i"); | ||
| return checkedItemPattern.test(normalizedBody); | ||
| } | ||
|
|
||
| // --------------------------------------------------------------------------- | ||
| // 1. Required section headings (tolerant to spacing and casing) | ||
| // --------------------------------------------------------------------------- | ||
| const requiredSections = [ | ||
| { | ||
| label: "### Addressed Issues:", | ||
| pattern: /#{3}\s+addressed\s+issues:/i, | ||
| }, | ||
| { | ||
| label: "## Checklist", | ||
| pattern: /#{2}\s+checklist/i, | ||
| }, | ||
| ]; | ||
|
|
||
| const missingSections = requiredSections | ||
| .filter((section) => !section.pattern.test(normalizedBody)) | ||
| .map((section) => section.label); | ||
|
|
||
| if (!normalizedBody.trim()) { | ||
| fail("PR description is empty. Please follow the PR template."); | ||
| } | ||
|
|
||
| if (missingSections.length > 0) { | ||
| issues.push( | ||
| `**PR description is missing required sections:**\n` + | ||
| missingSections.map((s) => `- \`${s}\``).join("\n") + | ||
| `\n\nPlease follow the [PR template](.github/PULL_REQUEST_TEMPLATE.md).` | ||
| ); | ||
| } | ||
|
kpj2006 marked this conversation as resolved.
|
||
|
|
||
| // --------------------------------------------------------------------------- | ||
| // 2. Issue link — warn on placeholder and missing issue reference | ||
| // --------------------------------------------------------------------------- | ||
| if (/\bfixes\s*#\s*\(\s*issue\s*number\s*\)/i.test(normalizedBody)) { | ||
| issues.push( | ||
| "Please replace the placeholder `Fixes #(issue number)` with the actual " + | ||
| "issue number (e.g. `Fixes #42`)." | ||
| ); | ||
| } else if (!/\b(fixes|closes|resolves)\s*#\d+\b/i.test(normalizedBody)) { | ||
| issues.push( | ||
| "No issue linked. Consider adding `Fixes #<number>` (e.g. `Fixes #42`) " + | ||
| "under the **Addressed Issues** section." | ||
| ); | ||
| } | ||
|
|
||
| // --------------------------------------------------------------------------- | ||
| // 3. Checklist — required items must be checked | ||
| // --------------------------------------------------------------------------- | ||
| const requiredChecklistItems = [ | ||
| "My PR addresses a single issue", | ||
| "My code follows the project's code style", | ||
| "My changes generate no new warnings or errors", | ||
| ]; | ||
|
kpj2006 marked this conversation as resolved.
|
||
|
|
||
| const missingRequired = requiredChecklistItems.filter( | ||
| (item) => !hasCheckedChecklistItem(item) | ||
| ); | ||
|
|
||
| if (missingRequired.length > 0) { | ||
| issues.push( | ||
| "Some required checklist items are not completed:\n" + | ||
| missingRequired.map((item) => `- ${item}`).join("\n") | ||
| ); | ||
| } | ||
|
|
||
| if (issues.length > 0) { | ||
| message(` | ||
| ### ⚠️ PR Template Check | ||
|
|
||
| These are non-blocking, but please fix: | ||
|
|
||
| ${issues.map((issue) => `- ${issue}`).join("\n")} | ||
| `); | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.