MIJN-6651 - release notificaties

.github/workflows/pr-title-check.yml

@@ -0,0 +1,26 @@
+# Taken from: https://levelup.gitconnected.com/enforcing-jira-ticket-formatting-in-github-pr-titles-and-commit-messages-78d9755568df
+name: 'PR Title Check'
+on:
+  pull_request:
+    types: [opened, edited, synchronize]
+jobs:
+  check-title:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check PR title
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const payload = context.payload
+            const prTitle = payload.pull_request.title
+
+            // Titel moet beginnen met mijn-xxxx of Bump!
+            const jiraPattern = /(mijn-\d+|bump!)/gi
+            if (!jiraPattern.test(prTitle)) {
+              console.log('The PR title does not match JIRA ticket format!')
+              // Fails the workflow
+              core.setFailed('PR title does not match JIRA ticket format!')
+            } else {
+              console.log('PR title format is correct.')
+            }

.github/workflows/release-notification.yml

@@ -0,0 +1,17 @@
+name: 'Release notification'
+on: create
+jobs:
+  create-notification:
+    if: ${{ contains(github.ref, 'release-v') }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - name: Create release notification
+        env:
+          webhook_host: ${{ secrets.MS_TEAMS_WEBHOOK_HOST }}
+          webhook_path: ${{ secrets.MS_TEAMS_RELEASE_NOTIFICATION_WEBHOOK_PATH }}
+        run: npm run release:notification

package.json

@@ -20,7 +20,8 @@
     "bff-api:test": "cross-env MA_APP_MODE=unittest vitest --environment=node src/server src/universal",
     "bff-api:serve-build": "node build-bff/server/app",
     "bff-api:serve-dev": "ts-node --project ./tsconfig.bff.json ./src/bffserver.ts",
-    "bff-api:build": "tsc --project ./tsconfig.bff.json"
+    "bff-api:build": "tsc --project ./tsconfig.bff.json",
+    "release:notification": "node scripts/release-notifications/release-notes"
   },
   "browserslist": [
     ">0.2%",

scripts/release-notifications/card.js

@@ -0,0 +1,113 @@
+function getReleaseCardJson(changes) {
+  const now = new Date();
+
+  const rows = changes.map((change) => ({
+    type: 'TableRow',
+    cells: [
+      {
+        type: 'TableCell',
+        items: [
+          {
+            type: 'TextBlock',
+            text: `[${change.ticket}](https://gemeente-amsterdam.atlassian.net/browse/${change.ticket})`,
+            wrap: true,
+          },
+        ],
+      },
+      {
+        type: 'TableCell',
+        items: [
+          {
+            type: 'TextBlock',
+            text: change.description,
+            wrap: true,
+          },
+        ],
+      },
+      {
+        type: 'TableCell',
+        items: [
+          {
+            type: 'TextBlock',
+            text: change.date,
+            wrap: true,
+          },
+        ],
+      },
+    ],
+  }));
+
+  return {
+    type: 'AdaptiveCard',
+    $schema: 'http://adaptivecards.io/schemas/adaptive-card.json',
+    version: '1.5',
+    body: [
+      {
+        type: 'TextBlock',
+        text: `Release overzicht van ${now.getDate()}-${
+          now.getMonth() + 1
+        }-${now.getFullYear()}`,
+        wrap: true,
+        style: 'heading',
+      },
+      {
+        type: 'Table',
+        columns: [
+          {
+            width: 1,
+          },
+          {
+            width: 2,
+          },
+          {
+            width: 3,
+          },
+        ],
+        rows: [
+          {
+            type: 'TableRow',
+            cells: [
+              {
+                type: 'TableCell',
+                items: [
+                  {
+                    type: 'TextBlock',
+                    text: 'Ticket',
+                    wrap: true,
+                  },
+                ],
+                style: 'accent',
+              },
+              {
+                type: 'TableCell',
+                items: [
+                  {
+                    type: 'TextBlock',
+                    text: 'Omschrijving',
+                    wrap: true,
+                  },
+                ],
+                style: 'accent',
+              },
+              {
+                type: 'TableCell',
+                items: [
+                  {
+                    type: 'TextBlock',
+                    text: 'Dagen in main',
+                    wrap: true,
+                  },
+                ],
+                style: 'accent',
+              },
+            ],
+          },
+          ...rows,
+        ],
+        firstRowAsHeader: true,
+      },
+    ],
+  };
+}
+
+module.exports = { getReleaseCardJson };

scripts/release-notifications/release-notes.js

@@ -0,0 +1,80 @@
+const child_process = require('child_process');
+const { getReleaseCardJson } = require('./card');
+const { sendTeamsMessage } = require('./teams');
+
+const RELEASE_MERGE_MESSAGE = 'Bump!';
+
+// Small wrapper
+function executeCommandSync(command) {
+  return child_process.execSync(command).toString();
+}
+
+function getDateDiff(date1, date2 = new Date()) {
+  if (
+    date1.getDate() === date2.getDate() &&
+    date1.getMonth() === date2.getMonth() &&
+    date1.getFullYear() === date2.getFullYear()
+  ) {
+    return `Sinds vandaag in main`;
+  }
+
+  //Set hours, minutes and seconds to zero
+  date1.setHours(0, 0, 0, 0);
+  date2.setHours(0, 0, 0, 0);
+
+  const t2 = date2.getTime(); //Get time in milliseconds.
+  const t1 = date1.getTime();
+
+  //Subtract and divide by 1 day (in milliseconds)
+  const diff = parseInt((t2 - t1) / (24 * 3600 * 1000), 10);
+
+  return `Sinds ${diff} ${diff > 1 ? 'dagen' : 'dag'} in main`;
+}
+
+function getChangesSinceLastRelease() {
+  const tag = executeCommandSync(
+    'git tag -l release-* --sort=-"version:refname"'
+  ).slice(0, 16);
+  console.log(`Latest release tag found: ${tag}`);
+
+  const commitId = executeCommandSync(`git rev-list -n 1 ${tag}`);
+
+  const dateOfLastTag = executeCommandSync(
+    `git show -s --format=%ci ${commitId}`
+  );
+  console.log(`Date of last tag: ${dateOfLastTag}`);
+
+  const lines = executeCommandSync(
+    `git log --pretty="%s %cI" --no-merges --since="${dateOfLastTag}"`
+  );
+
+  const splitLines = lines.trim().split(/(?:\r\n|\r|\n)/g);
+  const jiraTicketRegex =
+    /(mijn(-| )\d+|bump!)([\s-]+)([a-zA-Z\s]+)\(#([\d]+)\)/gi;
+
+  return splitLines
+    .map((line) => {
+      if (line.startsWith(RELEASE_MERGE_MESSAGE)) {
+        return; // The release is merged after the release tag is created.
+        // So we might (should) encounter the previous release merge commit.
+      }
+
+      const match = jiraTicketRegex.exec(line.trim());
+
+      if (!!match) {
+        // each line is a commit message since the last release
+
+        return {
+          ticket: match[1].trim().replace(' ', '-'),
+          description: match[4],
+          pr: match[5],
+          date: getDateDiff(new Date(line.slice(-25))),
+        };
+      }
+    })
+    .filter(Boolean); // Filter empty entries
+}
+
+const changes = getChangesSinceLastRelease();
+const cardJson = getReleaseCardJson(changes);
+sendTeamsMessage(cardJson, process.env.webhook_host, process.env.webhook_path);

scripts/release-notifications/teams.js

@@ -0,0 +1,50 @@
+const https = require('https');
+
+function sendTeamsMessage(cardJson, host, path) {
+  const post_data = JSON.stringify({
+    type: 'message',
+    attachments: [
+      {
+        contentType: 'application/vnd.microsoft.card.adaptive',
+        contentUrl: null,
+        content: cardJson,
+      },
+    ],
+  });
+
+  const post_options = {
+    host,
+    port: 443,
+    path,
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      'Content-Length': Buffer.byteLength(post_data),
+      'User-Agent': 'nodejs',
+    },
+  };
+
+  try {
+    // Set up the request
+    const post_req = https.request(post_options, function (res) {
+      res.setEncoding('utf8');
+      res.on('error', function (err) {
+        console.error(err.stack);
+        process.exit();
+      });
+      res.on('data', function (chunk) {
+        console.log('Response: ' + chunk);
+      });
+    });
+
+    post_req.write(post_data);
+    post_req.end();
+  } catch (e) {
+    console.error(e);
+    process.exit();
+  }
+}
+
+module.exports = {
+  sendTeamsMessage,
+};