Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 102 additions & 0 deletions .github/workflows/pr-vm-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# PR VM check — boot the suites a pull request affects, before it merges
#
# Plans the PR's changed files exactly as the post-merge v1 gate does
# (scripts/vm_validation_plan.py, scripts/v1_gate.py) and, when a VM is
# needed, boots those suites through e2e.yml on dakota:testing pinned by
# digest. A PR that reaches no VM (docs, unit tests, repo tooling) finishes
# the plan in seconds and boots nothing.
#
# Why: e2e.yml only runs when something calls it, and contributor agents may
# not dispatch workflows, so until now a VM-related change got its first VM
# run after merge (as a v1 hold) or when a maintainer started a manual run.
# This gives every such PR its own VM evidence.
#
# Advisory for now: not a required check. Fork PRs get a read-only token, so
# e2e.yml's screenshot push (continue-on-error) is skipped there; nothing else
# needs a write token or a secret.

name: PR VM check

on:
pull_request:
branches: [main]

permissions:
contents: read

concurrency:
group: pr-vm-check-${{ github.event.pull_request.number }}
cancel-in-progress: true

jobs:
plan:
name: Plan VM check
runs-on: ubuntu-latest
timeout-minutes: 10
outputs:
action: ${{ steps.plan.outputs.action }}
suites: ${{ steps.plan.outputs.suites }}
image: ${{ steps.image.outputs.image }}
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
with:
fetch-depth: 2
persist-credentials: false

- name: Plan
id: plan
run: |
set -euo pipefail
# The checkout is GitHub's merge commit; its first parent is the base,
# so this is exactly the PR's own change even if main has moved.
git diff --name-only HEAD^1 HEAD > changed.txt
python3 scripts/vm_validation_plan.py < changed.txt > plan.json
python3 scripts/v1_gate.py < plan.json | tee -a "$GITHUB_OUTPUT" > decision.txt
{
echo "### PR VM check plan"
echo
echo '```'
cat decision.txt
echo '```'
echo
echo '```json'
cat plan.json
echo '```'
} >> "$GITHUB_STEP_SUMMARY"
# "hold" means a changed path needs a lane e2e.yml cannot boot (the
# gnome-e2e composite action, or a suite with no hosted lane); say so
# rather than boot something that would not cover it.
if grep -q '^action=hold$' decision.txt; then
echo "::notice::This PR changes something the VM check cannot boot; validate it by hand (see the plan in the summary)."
fi

- name: Pin dakota:testing by digest
id: image
if: steps.plan.outputs.action == 'gate'
run: |
set -euo pipefail
NAME=ghcr.io/projectbluefin/dakota:testing
DIGEST=$(skopeo inspect --format '{{.Digest}}' "docker://${NAME}")
case "${DIGEST}" in
sha256:*) ;;
*) echo "::error::Could not resolve a digest for ${NAME}"; exit 1 ;;
esac
echo "image=${NAME}@${DIGEST}" >> "$GITHUB_OUTPUT"
echo "VM check image: \`${NAME}@${DIGEST}\`" >> "$GITHUB_STEP_SUMMARY"

boot:
name: Boot affected suites
needs: plan
if: needs.plan.outputs.action == 'gate'
# e2e.yml's jobs ask for packages: write (screenshot push); a called
# workflow cannot be granted less than its jobs request.
permissions:
contents: read
packages: write
uses: ./.github/workflows/e2e.yml
with:
image: ${{ needs.plan.outputs.image }}
suites: ${{ needs.plan.outputs.suites }}
test_ref: ${{ github.sha }}
test_repository: ${{ github.repository }}
20 changes: 20 additions & 0 deletions docs/skills/ci-ops/ops/references/candidate-vm-validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,26 @@ silently costs the full set, and a wrong empty rule silently skips validation.

## Running the plan against the PR's own code

Every pull request runs this plan automatically (`pr-vm-check.yml`, "PR VM
check"): it diffs GitHub's merge commit against its first
parent, runs `vm_validation_plan.py` and `v1_gate.py`, and when the decision is
`gate` boots those suites through `e2e.yml` on `dakota:testing` pinned by
digest, with `test_ref` set to the merge commit. `move` boots nothing; `hold`
(a lane `e2e.yml` cannot boot, such as the `gnome-e2e` composite action) posts
a notice and boots nothing. It is not a required check, but the hive merges no
PR while any check is red. A fork PR's token is read-only, so `e2e.yml`'s
screenshot push (continue-on-error) is skipped there. Use a manual run (below)
for another image. The manual run calls `e2e.yml` too, so it cannot cover a
`hold`:

- a `composite_action` lane (the `gnome-e2e` action, or
`scripts/extension_validation.py`, which only the action runs): dispatch
`gnomeos-canary.yml` on a branch at the PR's head. It calls the action and its
extension-validation gate at its own ref. A fork PR's head is pushed to a repo
branch such as `canary/pr-N` first;
- a suite without a hosted lane (`no_hosted_lane`, such as `security`): it needs
its own hardware, or a hand check of the change.

Dispatch `manual.yml` **on the PR branch in the fork**. It calls the fork's
`e2e.yml` revision and passes `test_repository: ${{ github.repository }}` and
`test_ref` = the dispatched branch, so the modified workflow and tests execute,
Expand Down
Loading