chore: implement CI job to validate Release Please's config and manifest (open-telemetry#1207)

Author: rauno56

.github/workflows/release-please-validate.yaml

@@ -0,0 +1,22 @@
+name: Validate Release Please Config
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  rp-validate:
+    runs-on: ubuntu-latest
+    container:
+      image: node:14
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install lerna
+        run: npm install -g lerna
+
+      - name: Ensure Release Please Config and Manifest are in sync with the repository
+        run: node scripts/check-release-please.mjs

scripts/check-release-please.mjs

@@ -0,0 +1,83 @@
+import { strict as assert } from 'assert';
+import * as childProcess from 'child_process';
+import path from 'path';
+import { readFileSync } from 'fs';
+
+/*
+	Enumerates through
+
+	- lerna packages,
+	- release please's manifest, and
+	- release please's config, and
+
+	makes sure all those lists are in sync. If not, guides you to do the correct thing
+*/
+
+const errors = [];
+const logErrorIf = (condition, errorMessage) => {
+	if (condition) {
+		errors.push(errorMessage);
+	}
+};
+const PROJECT_ROOT = process.cwd();
+const readJson = (filePath) => {
+	return JSON.parse(readFileSync(filePath));
+};
+const getProcessOutput = (cmd, args) => {
+	const result = childProcess.spawnSync(cmd, args);
+	assert(!result.error, result.error);
+	return result.stdout.toString('utf8');
+}
+
+const lernaList = JSON.parse(
+	getProcessOutput('lerna', ['list', '--json'])
+);
+const manifest = readJson('.release-please-manifest.json');
+const config = readJson('release-please-config.json');
+
+const lernaPackages = new Set(
+	lernaList.map((pkg) => {
+		return path.relative(PROJECT_ROOT, pkg.location);
+	})
+);
+const manifestPackages = new Set(Object.keys(manifest));
+const configPackages = new Set(Object.keys(config.packages));
+
+console.log('lerna packages', lernaPackages);
+console.log('manifest packages', manifestPackages);
+console.log('config packages', configPackages);
+
+lernaPackages.forEach((relativeLocation) => {
+	logErrorIf(
+		!manifestPackages.has(relativeLocation),
+		`Could not find ${relativeLocation} in .release-please-manifest.json. If you are adding a new package. Add following
+  "${relativeLocation}": "0.0.1",`);
+
+	logErrorIf(
+		!configPackages.has(relativeLocation),
+		`Could not find ${relativeLocation} in release-please-config.json. If you are adding a new package. Add following to "packages" object
+  "${relativeLocation}": {},`);
+
+});
+
+manifestPackages.forEach((relativeLocation) => {
+	logErrorIf(
+		!lernaPackages.has(relativeLocation),
+		`Extraneous path ${relativeLocation} in .release-please-manifest.json`
+	);
+});
+
+configPackages.forEach((relativeLocation) => {
+	logErrorIf(
+		!lernaPackages.has(relativeLocation),
+		`Extraneous path ${relativeLocation} in release-please-config.json`
+	);
+});
+
+if (errors.length) {
+	console.error('Errors occured:\n');
+	console.error(errors.join('\n\n'));
+	process.exit(1);
+} else {
+	console.error('OK');
+}