From 6b4e97d3fdf73b3f0138e46e89ba575e99c40760 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=B6gl-Brunner=20Michel?= Date: Mon, 16 Nov 2026 11:53:38 +0100 Subject: [PATCH] Use the shared host scripts, timestamp and PR test command workflows The CI host scripts move to community-scripts/ci (scripts/host/). The script timestamp and PR test command workflows keep only their triggers here and call the shared reusable workflows in community-scripts/ci. --- .github/workflows/pr-test-command.yml | 216 +---------------- .../workflows/scripts/ci-controller-setup.sh | 70 ------ .github/workflows/scripts/ci-vm-controller.sh | 201 --------------- .../workflows/scripts/incus-ci-host-setup.sh | 202 --------------- .../workflows/scripts/pve-ci-host-setup.sh | 229 ------------------ .../update-script-timestamp-on-sh-change.yml | 185 ++------------ 6 files changed, 24 insertions(+), 1079 deletions(-) delete mode 100644 .github/workflows/scripts/ci-controller-setup.sh delete mode 100644 .github/workflows/scripts/ci-vm-controller.sh delete mode 100644 .github/workflows/scripts/incus-ci-host-setup.sh delete mode 100644 .github/workflows/scripts/pve-ci-host-setup.sh diff --git a/.github/workflows/pr-test-command.yml b/.github/workflows/pr-test-command.yml index 570ffecca..a07591171 100644 --- a/.github/workflows/pr-test-command.yml +++ b/.github/workflows/pr-test-command.yml @@ -1,12 +1,8 @@ name: PR test command -# Posts a ready-to-run test command for reviewers. -# It uses this PR’s script branch with the production engine, since both resolve -# independently. ct/ scripts need community-scripts/core; vm/, tools/ and -# turnkey/ scripts run straight from the branch. -# -# pull_request_target allows comments on fork PRs. No PR code is checked out or -# executed; API inputs are validated and the comment is assembled in JavaScript. +# Posts a ready-to-run test command for the scripts a PR touches. The workflow +# lives in community-scripts/ci (shared with DevScripts and ProxmoxVE); this +# file only holds the trigger. Nothing from the PR is checked out or run. on: pull_request_target: @@ -19,209 +15,11 @@ on: - "tools/**" - "turnkey/**" +permissions: {} + jobs: - comment: - if: github.repository == 'community-scripts/ProxmoxVE' - runs-on: self-hosted + pr-test-command: permissions: pull-requests: write contents: read - steps: - - uses: actions/github-script@v9 - with: - script: | - const MARKER = ''; - const MAX_APPS = 10; - - const pr = context.payload.pull_request; - const head = pr.head.repo; // null when the fork is gone - if (!head) return; - - const owner = context.repo.owner; - const repo = context.repo.repo; - - // Git allows backticks in a ref name, and this one ends up inside a - // fenced block. Anything outside the ordinary set is not worth - // rendering, so bail rather than escape. - const ref = pr.head.ref; - if (!/^[A-Za-z0-9._\/-]+$/.test(ref)) return; - const base = `https://raw.githubusercontent.com/${head.full_name}/${ref}`; - - const files = await github.paginate(github.rest.pulls.listFiles, { - owner, repo, pull_number: pr.number, per_page: 100, - }); - - // ct/foo.sh and install/foo-install.sh are the same app. A removed - // file has nothing left to run. - const apps = new Map(); // slug -> {ct, install} - const others = []; - for (const f of files) { - if (f.status === 'removed') continue; - let m = f.filename.match(/^ct\/([a-z0-9][a-z0-9._-]*)\.sh$/); - if (m) { apps.set(m[1], { ...apps.get(m[1]), ct: true }); continue; } - m = f.filename.match(/^install\/([a-z0-9][a-z0-9._-]*)-install\.sh$/); - if (m) { apps.set(m[1], { ...apps.get(m[1]), install: true }); continue; } - if (/^(vm|tools|turnkey)\/[A-Za-z0-9._\/-]+\.sh$/.test(f.filename)) others.push(f.filename); - } - if (apps.size === 0 && others.length === 0) return; - others.sort(); - - // Where a tool runs is read from the script itself; it is never run. - const HOST = /(^|[\s;&|(`$])(pct|qm|pveam|pvesm|pvesh|pveversion)\s/m; - async function runsOn(path) { - if (path.startsWith('vm/')) return 'pve'; - const appliance = (path.split('/').pop().match(/(?:^|-)(pbs|pmg|pdm)(?=[0-9-]|\.sh$)/) || [])[1]; - if (path.startsWith('tools/pve/')) return appliance || 'pve'; - let text = ''; - try { - const res = await github.rest.repos.getContent({ - owner: head.owner.login, repo: head.name, path, ref: pr.head.sha, - }); - text = Buffer.from(res.data.content || '', 'base64').toString('utf8'); - } catch (e) {} - if (HOST.test(text.replace(/^\s*#.*$/gm, '').replace(/command -v \S+/g, ''))) return 'pve'; - if (appliance) return appliance; - return path.startsWith('tools/addon/') ? 'guest' : 'unknown'; - } - const WHERE = { - pve: 'in the Proxmox VE shell', - guest: 'inside the LXC or VM that should get it', - pbs: 'in the Proxmox Backup Server shell', - pmg: 'in the Proxmox Mail Gateway shell', - pdm: 'in the Proxmox Datacenter Manager shell', - unknown: 'wherever the script is meant to run', - }; - - // Read the ct script at the PR head to see which engine it loads. - // Read only -- it is never sourced or run. - async function bootstrapOf(slug) { - try { - const res = await github.rest.repos.getContent({ - owner: head.owner.login, repo: head.name, - path: `ct/${slug}.sh`, ref: pr.head.sha, - }); - if (!res.data.content) return 'unknown'; - const text = Buffer.from(res.data.content, 'base64').toString('utf8'); - const firstLines = text.split('\n').slice(0, 12).join('\n'); - return /_cs_boot=/.test(firstLines) ? 'core' : 'legacy'; - } catch (e) { - return e.status === 404 ? 'missing' : 'unknown'; - } - } - - const ready = [], legacy = [], missing = []; - for (const slug of [...apps.keys()].sort()) { - const kind = await bootstrapOf(slug); - if (kind === 'core') ready.push(slug); - else if (kind === 'legacy') legacy.push(slug); - else if (kind === 'missing') missing.push(slug); - } - - const lines = [MARKER]; - - if (ready.length > 0) { - const shown = ready.slice(0, MAX_APPS); - lines.push( - '### Try this branch', - '', - 'The engine and the scripts resolve independently, so this runs the changed', - '`ct/` and `install/` scripts against the **production** engine:', - '', - ); - for (const slug of shown) { - lines.push( - '```bash', - `export COMMUNITY_SCRIPTS_URL=${base}`, - `bash -c "$(curl -fsSL "$COMMUNITY_SCRIPTS_URL/ct/${slug}.sh")"`, - '```', - '', - ); - } - if (ready.length > shown.length) { - lines.push( - `${ready.length - shown.length} more script(s) changed; same command, different slug.`, - '', - ); - } - lines.push( - 'Both lines are needed. Without `COMMUNITY_SCRIPTS_URL` the engine falls back to', - '`main`, so curling the branch URL on its own gives you the `ct/` script from', - 'this PR and the `install/` script from `main`. Frequently the one you meant to test.', - '', - 'The same command works on an Incus host: the engine detects the platform and', - 'loads the matching backend, while the scripts still come from this branch.', - '', - '
Useful while testing', - '', - '`dev_mode=net` logs every fetch with status and URL, which is the quickest way', - 'to confirm the branch is really being used. `dev_mode=keep` stops a failed', - 'build from deleting the container along with the evidence.', - '', - '```bash', - `export COMMUNITY_SCRIPTS_URL=${base}`, - `dev_mode=net,keep bash -c "$(curl -fsSL "$COMMUNITY_SCRIPTS_URL/ct/${shown[0]}.sh")"`, - '```', - '
', - ); - } - - if (others.length > 0) { - const shown = others.slice(0, MAX_APPS); - lines.push(...(ready.length > 0 ? ['', '---', ''] : ['### Try this branch', ''])); - for (const path of shown) { - lines.push( - `\`${path}\`, run ${WHERE[await runsOn(path)]}:`, - '```bash', - `bash -c "$(curl -fsSL "${base}/${path}")"`, - '```', - '', - ); - } - if (others.length > shown.length) { - lines.push( - `${others.length - shown.length} more script(s) changed; same command, different path.`, - '', - ); - } - lines.push( - 'Only the script itself comes from this branch. The engine it loads still', - 'comes from community-scripts/core on `main`.', - ); - } - - if (legacy.length > 0) { - lines.push( - '', - ready.length > 0 ? '---' : '### Not testable this way yet', - '', - `\`${legacy.join('`, `')}\` still uses the older one-liner bootstrap, which`, - 'resolves everything from `ProxmoxVE/main` and ignores `COMMUNITY_SCRIPTS_URL`.', - 'There is no way to point it at this branch — test it from a checkout on the', - 'host instead, or migrate the script to the `_cs_boot` bootstrap first.', - ); - } - - if (missing.length > 0) { - lines.push( - '', - `No \`ct/\` script found for \`${missing.join('`, `')}\`, so there is nothing to`, - 'run. If the install script was renamed, its `ct/` counterpart needs the same', - 'name.', - ); - } - - if (lines.length === 1) return; // marker only, nothing worth saying - const body = lines.join('\n'); - - // Update in place rather than posting again on every push. - const comments = await github.paginate(github.rest.issues.listComments, { - owner, repo, issue_number: pr.number, per_page: 100, - }); - const mine = comments.find(c => c.body.includes(MARKER)); - if (mine) { - if (mine.body !== body) { - await github.rest.issues.updateComment({ owner, repo, comment_id: mine.id, body }); - } - } else { - await github.rest.issues.createComment({ owner, repo, issue_number: pr.number, body }); - } + uses: community-scripts/ci/.github/workflows/pr-test-command.yml@main diff --git a/.github/workflows/scripts/ci-controller-setup.sh b/.github/workflows/scripts/ci-controller-setup.sh deleted file mode 100644 index b2236eaaf..000000000 --- a/.github/workflows/scripts/ci-controller-setup.sh +++ /dev/null @@ -1,70 +0,0 @@ -#!/usr/bin/env bash -# Installs ci-vm-controller.sh on the hypervisor (prox1): the script, the -# token reader, a systemd unit per CI VM, and each VM's config. Run as root -# on prox1 from a directory that also holds ci-vm-controller.sh: -# -# scp ci-controller-setup.sh ci-vm-controller.sh root@prox1:/root/ci-controller/ -# ssh root@prox1 'cd /root/ci-controller && bash ci-controller-setup.sh' -# -# It does not start anything: a VM goes into service with -# systemctl enable --now ci-vm-controller@ -# once it has a 'clean' snapshot without any runner registered (see -# docs/guides/pr-script-testing.md, "Single-use hosts"). -# -# The token (/etc/ci-controller/token) is put there by hand: a fine-grained -# token for the two repositories with Administration: read and write only. - -set -euo pipefail -cd "$(dirname "$0")" -[[ -f ci-vm-controller.sh ]] || { echo "ci-vm-controller.sh missing next to this script" >&2; exit 1; } -command -v jq >/dev/null || DEBIAN_FRONTEND=noninteractive apt-get install -y -qq jq >/dev/null - -install -m 755 ci-vm-controller.sh /usr/local/sbin/ci-vm-controller.sh -install -d -m 700 /etc/ci-controller - -cat >/usr/local/sbin/ci-gh-token <<'EOF' -#!/bin/sh -# Prints the token ci-vm-controller.sh uses (Administration: write on the CI -# repositories). Swap this for a GitHub App token later without touching -# the controller. -exec cat /etc/ci-controller/token -EOF -chmod 755 /usr/local/sbin/ci-gh-token - -cat >/etc/systemd/system/ci-vm-controller@.service <<'EOF' -[Unit] -Description=Single-use CI runner host, VM %i -After=network-online.target pve-cluster.service pvedaemon.service -Wants=network-online.target -# A missing token is a setup error, not something to retry every 30 s. -ConditionPathExists=/etc/ci-controller/token - -[Service] -ExecStart=/usr/local/sbin/ci-vm-controller.sh %i -Restart=always -RestartSec=30 -# Stopping the controller leaves the VM as it is; the next start resets it, -# which also ends a job that may still be running there. -KillMode=mixed - -[Install] -WantedBy=multi-user.target -EOF - -# One repository per host: see ci-vm-controller.sh. -conf() { # conf