Merge branch 'main' into test

Author: AugustinMauroy

.github/dependabot.yml

@@ -8,18 +8,26 @@
 version: 2
 
 updates:
+
   - package-ecosystem: github-actions
+    commit-message:
+      prefix: dep(GHA)
     directory: /
+    labels:
+      - "dependencies"
+      - "gh actions"
     schedule:
       interval: monthly
-    commit-message:
-      prefix: ci
 
   - package-ecosystem: npm # See documentation for possible values
+    commit-message:
+      prefix: dep(prod)
+      prefix-development: dep(dev)
     directories:
       - / # Location of package manifests
       - /recipies/*
-    commit-message:
-      prefix: deps
+    labels:
+      - "dependencies"
+      - "npm"
     schedule:
       interval: weekly

.github/scripts/pr-prefixes.ts

@@ -0,0 +1,13 @@
+/**
+ * The subset of conventional commit prefixes used in this project.
+ */
+export const SUPPORTED_PREFIXES = [
+	'doc',
+	'dep',
+	'fix',
+	'feat',
+	'setup',
+	'test',
+] as const;
+
+export const SCOPE_RGX = new RegExp(`^(${SUPPORTED_PREFIXES.join('|')})\\([\\w\\-\\d]*\\)\\: `);

.github/scripts/pr-title.test.ts

@@ -0,0 +1,79 @@
+import { equal, match } from 'node:assert/strict';
+import { execPath } from 'node:process';
+import { describe, it } from 'node:test';
+import { fileURLToPath } from 'node:url';
+
+import { spawnPromisified } from '../../utils/src/spawn-promisified.ts';
+
+import { SUPPORTED_PREFIXES } from './pr-prefixes.ts';
+
+describe('Pull Request checks', { concurrency: true }, async () => {
+	const encoding = 'utf8';
+	const prTestPath = fileURLToPath(import.meta.resolve('./pr-title.ts'));
+
+	for (const prefix of SUPPORTED_PREFIXES) {
+		describe(prefix, () => {
+			it('should pass when valid', async () => {
+				const { code, stderr } = await spawnPromisified(
+					execPath,
+					[prTestPath],
+					{
+						encoding,
+						env: { PR_TITLE: `${prefix}(DEP0000): update …` },
+					},
+				);
+
+				equal(stderr, '');
+				equal(code, 0);
+			});
+
+			it('should fail when missing scope', async () => {
+				const { code, stderr } = await spawnPromisified(
+					execPath,
+					[prTestPath],
+					{
+						encoding,
+						env: { PR_TITLE: `${prefix}: update …` },
+					},
+				);
+
+				match(stderr, /AssertionError/);
+				match(stderr, new RegExp(prefix));
+				match(stderr, /pull request title/i);
+				equal(code, 1);
+			});
+
+			it('should fail scope is misformatted', async () => {
+				const { code, stderr } = await spawnPromisified(
+					execPath,
+					[prTestPath],
+					{
+						encoding,
+						env: { PR_TITLE: `${prefix}(DEP0000) update …` },
+					},
+				);
+
+				match(stderr, /AssertionError/);
+				match(stderr, new RegExp(prefix));
+				match(stderr, /pull request title/i);
+				equal(code, 1);
+			});
+		});
+	}
+
+	describe('unsupported prefix', () => {
+		it('should fail', async () => {
+			const prefix = 'foo';
+			const { code, stderr } = await spawnPromisified(execPath, [prTestPath], {
+				encoding,
+				env: { PR_TITLE: `${prefix}(DEP0000): update …` },
+			});
+
+			match(stderr, /AssertionError/);
+			match(stderr, new RegExp(prefix));
+			match(stderr, /pull request title/i);
+			for (const p of SUPPORTED_PREFIXES) match(stderr, new RegExp(p));
+			equal(code, 1);
+		});
+	})
+});

.github/scripts/pr-title.ts

@@ -0,0 +1,27 @@
+import assert from 'node:assert/strict';
+import { env } from 'node:process';
+
+import { SCOPE_RGX, SUPPORTED_PREFIXES } from './pr-prefixes.ts';
+
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+			PR_TITLE: string;
+		}
+	}
+}
+
+const { PR_TITLE } = env;
+
+const INVALID_PR_TITLE_ERR = '\
+The pull request title did not match the required format; see CONTRIBUTING.md for details.\
+';
+
+assert.match(PR_TITLE, SCOPE_RGX, INVALID_PR_TITLE_ERR);
+const firstParen = PR_TITLE.indexOf('(');
+const prefix = PR_TITLE.slice(0, firstParen);
+
+assert.ok(
+	SUPPORTED_PREFIXES.includes(prefix),
+	`The pull request title prefix '${prefix}' is not in the supported list: '${SUPPORTED_PREFIXES.join("', '")}'`,
+);