feat: module common config deploy

Julusian · Julusian · commit 0d2fa3c33a8d · 2025-09-29T22:58:23.000+01:00
diff --git a/.github/workflows/module-common-config-deploy.yml b/.github/workflows/module-common-config-deploy.yml
@@ -0,0 +1,54 @@
+name: Create and publish module-common-config-deploy image
+
+on:
+  push:
+    branches: ["main"]
+    paths:
+      - "module-common-config-deploy/**"
+      - ".github/workflows/module-common-config-deploy.yml"
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}-module-common-config-deploy
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      attestations: write
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        id: push
+        uses: docker/build-push-action@v6
+        with:
+          context: module-common-config-deploy
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v3
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true
diff --git a/module-common-config-deploy/.dockerignore b/module-common-config-deploy/.dockerignore
@@ -0,0 +1,2 @@
+node_modules
+.env
diff --git a/module-common-config-deploy/.gitattributes b/module-common-config-deploy/.gitattributes
@@ -0,0 +1,4 @@
+/.yarn/**            linguist-vendored
+/.yarn/releases/*    binary
+/.yarn/plugins/**/*  binary
+/.pnp.*              binary linguist-generated
diff --git a/module-common-config-deploy/.gitignore b/module-common-config-deploy/.gitignore
@@ -0,0 +1,16 @@
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Swap the comments on the following lines if you wish to use zero-installs
+# In that case, don't forget to run `yarn config set enableGlobalCache false`!
+# Documentation here: https://yarnpkg.com/features/caching#zero-installs
+
+#!.yarn/cache
+.pnp.*
+node_modules
+
+.env
diff --git a/module-common-config-deploy/.nvmrc b/module-common-config-deploy/.nvmrc
@@ -0,0 +1 @@
+22
diff --git a/module-common-config-deploy/.prettierignore b/module-common-config-deploy/.prettierignore
@@ -0,0 +1 @@
+package.json
diff --git a/module-common-config-deploy/.prettierrc b/module-common-config-deploy/.prettierrc
@@ -0,0 +1,10 @@
+{
+	"arrowParens": "always",
+	"bracketSpacing": true,
+	"printWidth": 120,
+	"semi": false,
+	"singleQuote": true,
+	"useTabs": true,
+	"endOfLine": "lf",
+	"trailingComma": "es5"
+}
diff --git a/module-common-config-deploy/.yarnrc.yml b/module-common-config-deploy/.yarnrc.yml
@@ -0,0 +1 @@
+nodeLinker: node-modules
diff --git a/module-common-config-deploy/Dockerfile b/module-common-config-deploy/Dockerfile
@@ -0,0 +1,10 @@
+FROM node:22-alpine
+RUN apk add --no-cache tzdata
+
+WORKDIR /app
+COPY . .
+
+RUN corepack enable
+RUN yarn install --immutable
+
+CMD ["node", "./main.mjs"]
diff --git a/module-common-config-deploy/README.md b/module-common-config-deploy/README.md
@@ -0,0 +1,3 @@
+# companion-common-config-deploy
+
+Ensures every module repository has some common config/tooling
diff --git a/module-common-config-deploy/main.mjs b/module-common-config-deploy/main.mjs
@@ -0,0 +1,82 @@
+import { Octokit } from 'octokit'
+import dotenv from 'dotenv'
+import PLazy from 'p-lazy'
+dotenv.config()
+
+const octokit = new Octokit({ auth: process.env.GITHUB_TOKEN })
+
+const {
+	data: { login },
+} = await octokit.rest.users.getAuthenticated()
+console.log('Hello, %s', login)
+
+const targetContentBase64 = PLazy.from(async () => {
+	const checkManifestExists = await octokit.rest.repos.getContent({
+		owner: 'bitfocus',
+		repo: 'companion-module-template-ts',
+		path: '.github/workflows/companion-module-checks.yaml',
+	})
+	if (!checkManifestExists || checkManifestExists.status !== 200) {
+		throw new Error('Failed to get template workflow')
+	}
+
+	const data = checkManifestExists.data.content
+	if (!data) throw new Error('Failed to get template workflow')
+
+	return data
+})
+
+const errors = []
+
+const allRepos = await octokit.paginate(octokit.rest.repos.listForOrg, {
+	org: 'bitfocus',
+})
+console.log('found %d repos in org', allRepos.length)
+
+for (const repo of allRepos) {
+	const repoName = repo.name
+	if (!repoName.startsWith('companion-module-')) {
+		continue
+	}
+
+	try {
+		const checkManifestExists = await octokit.rest.repos
+			.getContent({
+				owner: 'bitfocus',
+				repo: repoName,
+				path: 'companion/manifest.json',
+			})
+			.then(() => true)
+			.catch((e) => (e.status === 404 ? false : Promise.reject(e)))
+		if (!checkManifestExists) {
+			console.log(`Skipping ${repoName}: manifest.json does not exist`)
+			continue
+		}
+
+		const checkExists = await octokit.rest.repos
+			.getContent({
+				owner: 'bitfocus',
+				repo: repoName,
+				path: '.github/workflows/companion-module-checks.yaml',
+			})
+			.then(() => true)
+			.catch((e) => (e.status === 404 ? false : Promise.reject(e)))
+
+		console.log(`Checked ${repoName}: ${checkExists ? 'exists' : 'does not exist'}`)
+		if (!checkExists) {
+			// Future: this should do something more patch like
+			await octokit.rest.repos.createOrUpdateFileContents({
+				owner: 'bitfocus',
+				repo: repoName,
+				path: '.github/workflows/companion-module-checks.yaml',
+				content: await targetContentBase64,
+				message: "chore: add 'Companion Module Checks' workflow",
+			})
+		}
+	} catch (e) {
+		console.error(`Failed ${repoName}: ${e?.message ?? e?.toString() ?? e}`)
+		errors.push(e)
+	}
+}
+
+console.log('All errors', errors)
diff --git a/module-common-config-deploy/package.json b/module-common-config-deploy/package.json
@@ -0,0 +1,10 @@
+{
+	"name": "common-config-deploy",
+	"packageManager": "yarn@4.9.1",
+	"dependencies": {
+		"dotenv": "^16.5.0",
+		"octokit": "^4.1.3",
+		"p-lazy": "^5.0.0",
+		"semver": "^7.7.1"
+	}
+}
diff --git a/module-common-config-deploy/yarn.lock b/module-common-config-deploy/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# companion-common-config-deploy`
	`2`	`+`
	`3`	`+Ensures every module repository has some common config/tooling`