ci(actions): add action to omit PR from changelog

.github/scripts/omitPrFromChangelog.js

@@ -0,0 +1,39 @@
+// @ts-check
+const {
+  labels: { planning },
+} = require("./support/resources");
+
+/** @param {import('github-script').AsyncFunctionArguments} AsyncFunctionArguments */
+module.exports = async ({ github, context }) => {
+  const { repo, owner } = context.repo;
+  const payload = /** @type {import('@octokit/webhooks-types').PullRequestLabeledEvent} */ (context.payload);
+  const {
+    label,
+    pull_request: { number },
+  } = payload;
+
+  const pullRequestBody = payload.pull_request.body;
+  const ommitComment = `\n\nBEGIN_COMMIT_OVERRIDE\nEND_COMMIT_OVERRIDE`;
+
+  if (!pullRequestBody) {
+    console.log("No issue body was found");
+    return;
+  }
+
+  if (label?.name === planning.noChangelogEntry) {
+    const pullRequestProps = {
+      owner,
+      repo,
+      pull_number: number,
+    };
+
+    const newPullRequestBody = pullRequestBody + ommitComment;
+
+    await github.rest.pulls.update({
+      ...pullRequestProps,
+      body: newPullRequestBody,
+    });
+  } else {
+    console.log(`The \`no changleog entry\` label is not present on this PR.`);
+  }
+};

.github/scripts/support/resources.js

@@ -29,6 +29,7 @@ const resources = {
       needsMilestone: "needs milestone",
       spike: "spike",
       spikeComplete: "spike complete",
+      noChangelogEntry: "no changelog entry",
     },
     priority: {
       low: "p - low",

.github/workflows/omit-pr-from-changelog.yml

@@ -0,0 +1,20 @@
+name: Remove PR from changelog
+on:
+  pull_request:
+    types:
+      - labeled
+      - opened
+    branches:
+      - dev
+jobs:
+  product-label:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Add omit comment to PR
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const action = require('${{ github.workspace }}/.github/scripts/omitPrFromChangelog.js')
+            await action({github, context, core})