mirror of
https://github.com/tiennm99/is-a-dev.git
synced 2026-10-12 18:16:23 +00:00
Enhance PR workflow with template validation
Updated PR workflow to include additional event types and added a template validation step.
This commit is contained in:
William Harrison authored and GitHub committed
1 parent
43ad213be8
commit
cd783fc616
1 file changed
+246
@@ -0,0 +1,246 @@
|
||||
name: PR
|
||||
|
||||
on:
|
||||
pull_request_target:
|
||||
types:
|
||||
- opened
|
||||
- reopened
|
||||
- edited
|
||||
- synchronize
|
||||
- labeled
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: write
|
||||
issues: write
|
||||
|
||||
jobs:
|
||||
label:
|
||||
name: Label
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Check changed paths
|
||||
id: changes
|
||||
uses: dorny/paths-filter@v3
|
||||
with:
|
||||
filters: |
|
||||
ci:
|
||||
- ".github/workflows/*"
|
||||
- "tests/*"
|
||||
- "util/*"
|
||||
- "package.json"
|
||||
- "package-lock.json"
|
||||
- "dnsconfig.js"
|
||||
domain:
|
||||
- "domains/*"
|
||||
|
||||
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
with:
|
||||
ref: ${{ github.event.repository.default_branch }}
|
||||
|
||||
- name: Check trusted user
|
||||
id: check
|
||||
env:
|
||||
PR_AUTHOR_ID: ${{ github.event.pull_request.user.id }}
|
||||
run: |
|
||||
node - <<'NODE'
|
||||
const trustedUsers = require("./util/trusted.json");
|
||||
|
||||
const authorId = Number(process.env.PR_AUTHOR_ID);
|
||||
|
||||
if (!trustedUsers.some((u) => u.id === authorId)) {
|
||||
console.log("PR author is not a trusted user.");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
console.log("PR author is a trusted user.");
|
||||
NODE
|
||||
|
||||
- name: Add labels
|
||||
uses: actions/github-script@v8
|
||||
env:
|
||||
CI_CHANGED: ${{ steps.changes.outputs.ci }}
|
||||
DOMAIN_CHANGED: ${{ steps.changes.outputs.domain }}
|
||||
MAINTAINER: ${{ steps.check.outcome == 'success' }}
|
||||
with:
|
||||
github-token: ${{ secrets.BOT }}
|
||||
script: |
|
||||
const labels = [];
|
||||
|
||||
if (process.env.CI_CHANGED === "true")
|
||||
labels.push("ci");
|
||||
|
||||
if (process.env.DOMAIN_CHANGED === "true")
|
||||
labels.push("domain");
|
||||
|
||||
if (process.env.MAINTAINER === "true")
|
||||
labels.push("maintainer");
|
||||
|
||||
if (labels.length) {
|
||||
await github.rest.issues.addLabels({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: context.issue.number,
|
||||
labels
|
||||
});
|
||||
}
|
||||
|
||||
template:
|
||||
name: Template
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
with:
|
||||
ref: ${{ github.event.repository.default_branch }}
|
||||
|
||||
- name: Validate PR template
|
||||
id: validate
|
||||
continue-on-error: true
|
||||
env:
|
||||
PR_BODY: ${{ github.event.pull_request.body }}
|
||||
PR_AUTHOR: ${{ github.event.pull_request.user.login }}
|
||||
PR_AUTHOR_ID: ${{ github.event.pull_request.user.id }}
|
||||
PR_LABELS: ${{ toJSON(github.event.pull_request.labels.*.name) }}
|
||||
run: node util/check-pr-template.cjs
|
||||
|
||||
- name: Handle incomplete PR
|
||||
if: steps.validate.outcome == 'failure'
|
||||
uses: actions/github-script@v8
|
||||
with:
|
||||
github-token: ${{ secrets.BOT }}
|
||||
script: |
|
||||
const label = "reason: incomplete pr";
|
||||
|
||||
try {
|
||||
await github.rest.issues.getLabel({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
name: label
|
||||
});
|
||||
} catch (error) {
|
||||
if (error.status === 404) {
|
||||
await github.rest.issues.createLabel({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
name: label,
|
||||
color: "D93F0B",
|
||||
description: "Your PR template is not complete. (e.g. missing the requirements form, missing website preview)"
|
||||
});
|
||||
} else {
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
const labels = await github.rest.issues.listLabelsOnIssue({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: context.issue.number
|
||||
});
|
||||
|
||||
if (!labels.data.some((item) => item.name === label)) {
|
||||
await github.rest.issues.addLabels({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: context.issue.number,
|
||||
labels: [label]
|
||||
});
|
||||
}
|
||||
|
||||
const marker = "<!-- is-a-dev-bot: incomplete-pr-template -->";
|
||||
|
||||
const comments = await github.paginate(
|
||||
github.rest.issues.listComments,
|
||||
{
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: context.issue.number
|
||||
}
|
||||
);
|
||||
|
||||
const alreadyCommented = comments.some(
|
||||
(comment) =>
|
||||
comment.user?.login === "is-a-dev-bot" &&
|
||||
comment.body?.includes(marker)
|
||||
);
|
||||
|
||||
if (!alreadyCommented) {
|
||||
const body = [
|
||||
marker,
|
||||
"## ❌ Incomplete PR template",
|
||||
"",
|
||||
"This pull request is missing required information from the PR template.",
|
||||
"",
|
||||
"***Your PR will not be approved without the template being properly filled out!***",
|
||||
"",
|
||||
"Please make sure that:",
|
||||
"",
|
||||
"- The PR template has not been modified.",
|
||||
" - *Modifying the PR template will make this check fail.*",
|
||||
"- All requirement checkboxes are checked.",
|
||||
" - *All checkboxes must be changed exactly to `[x]`, NOT something like `[ x ]`.*",
|
||||
"- **Website Preview** is filled out.",
|
||||
" - *Make sure it is filled between the start/end comment markers.*",
|
||||
"- **Website Purpose** is filled out.",
|
||||
" - *Make sure it is filled between the start/end comment markers.*",
|
||||
"---",
|
||||
"Once the template has been properly completed, this check will run again automatically."
|
||||
].join("\n");
|
||||
|
||||
await github.rest.issues.createComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: context.issue.number,
|
||||
body
|
||||
});
|
||||
}
|
||||
|
||||
- name: Remove incomplete label and comment
|
||||
if: steps.validate.outcome == 'success'
|
||||
uses: actions/github-script@v8
|
||||
with:
|
||||
github-token: ${{ secrets.BOT }}
|
||||
script: |
|
||||
const label = "reason: incomplete pr";
|
||||
const marker = "<!-- is-a-dev-bot: incomplete-pr-template -->";
|
||||
|
||||
try {
|
||||
await github.rest.issues.removeLabel({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: context.issue.number,
|
||||
name: label
|
||||
});
|
||||
} catch (error) {
|
||||
if (error.status !== 404) {
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
const comments = await github.paginate(
|
||||
github.rest.issues.listComments,
|
||||
{
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: context.issue.number
|
||||
}
|
||||
);
|
||||
|
||||
for (const comment of comments) {
|
||||
if (
|
||||
comment.user?.login === "is-a-dev-bot" &&
|
||||
comment.body?.includes(marker)
|
||||
) {
|
||||
await github.rest.issues.deleteComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
comment_id: comment.id
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
- name: Fail if PR template is incomplete
|
||||
if: steps.validate.outcome == 'failure'
|
||||
run: |
|
||||
echo "::error::PR template is incomplete."
|
||||
exit 1
|
||||
Reference in new issue
Block a user