mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-17 22:33:12 +01:00
komorebi follows the tip of nixpkgs-unstable, so KWin and Plasma move under it each time flake.lock does, and the pull request that moves the lock runs the slow VM tier only when it is labeled. The `canary` job of ci.yaml, on the weekly schedule and on a manual run, copies the checkout, runs `nix flake update nixpkgs` in the copy and builds every check against the result: the checks that need no virtual machine, listed as the lint job lists them, then the suites of both tiers, listed from `vmTiers` as the discover job does. They run one after the other on one KVM runner, so that komorebi and the guests are built once against the new nixpkgs; the job may take the six hours a hosted runner allows. When a check fails, the job opens an issue titled "Canary: a check fails against the tip of nixpkgs-unstable" with the failed checks, the nixpkgs revision, and the KWin version at the tip and in flake.lock, or comments on that issue if it is open. The same report goes to the job summary on every run. The job's token can read the contents and write issues, nothing more, and the checkout keeps no credentials, so the repository is never changed. The composite action takes `cache: "false"`, which the canary passes. The store cache is keyed on flake.lock: what it restored would be the old nixpkgs, taking disk the guests need, and what it saved would replace the store of the jobs that do use the lock. `just lint` runs actionlint, with shellcheck over the scripts, both from the nixpkgs flake.lock pins, so the lint job and `just check` check the workflows. The steps were run as written on an x86_64 machine with KVM, against a fake gh: GitHub Actions has not run the job yet. CONTRIBUTING.md, docs/dev/vm-tests.md and DESIGN.md say what it does and why.
209 lines
8.0 KiB
YAML
209 lines
8.0 KiB
YAML
# Every job is gated on the repository, so that a fork does not run them on its own runners.
|
|
|
|
name: ci
|
|
|
|
on:
|
|
pull_request:
|
|
branches:
|
|
- "*"
|
|
push:
|
|
branches:
|
|
- master
|
|
- feature/*
|
|
- hotfix/*
|
|
tags:
|
|
- v*
|
|
schedule:
|
|
- cron: "30 0 * * 0" # Every Sunday at 00:30 UTC
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
cargo-deny:
|
|
if: github.repository == 'LGUG2Z/komorebi-for-kde'
|
|
runs-on: ubuntu-24.04
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
with:
|
|
fetch-depth: 0
|
|
- uses: EmbarkStudios/cargo-deny-action@v2
|
|
|
|
# Everything that does not need a virtual machine: the formatting, clippy, rustdoc, the tests and
|
|
# the VM library's own tests, as derivations. The jobs that boot KWin are separate, and `nix flake
|
|
# check` is not used here because on Linux it would run those suites with no KVM.
|
|
lint:
|
|
if: github.repository == 'LGUG2Z/komorebi-for-kde'
|
|
runs-on: ubuntu-24.04
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
with:
|
|
fetch-depth: 0
|
|
- uses: ./.github/actions/nix
|
|
- name: Build every check that needs no virtual machine
|
|
run: |
|
|
nix eval --json .#checks.x86_64-linux --apply builtins.attrNames |
|
|
jq -r '(.[] | select(startswith("vm-") | not)), "vm-lib"' |
|
|
sed 's|^|.#checks.x86_64-linux.|' |
|
|
xargs nix build -L --no-link
|
|
- run: nix develop --command just lint
|
|
|
|
# The suites are found in the flake, so that a new directory under nix/tests/vm/suites is run
|
|
# without an edit here.
|
|
discover:
|
|
if: github.repository == 'LGUG2Z/komorebi-for-kde'
|
|
runs-on: ubuntu-24.04
|
|
outputs:
|
|
fast: ${{ steps.tiers.outputs.fast }}
|
|
slow: ${{ steps.tiers.outputs.slow }}
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
- uses: ./.github/actions/nix
|
|
- id: tiers
|
|
run: |
|
|
tiers=$(nix eval --json .#legacyPackages.x86_64-linux.vmTiers)
|
|
echo "fast=$(jq -c '.fast // []' <<<"$tiers")" >> "$GITHUB_OUTPUT"
|
|
echo "slow=$(jq -c '.slow // []' <<<"$tiers")" >> "$GITHUB_OUTPUT"
|
|
|
|
# The pull request gate: the suites that take minutes, each in its own machine, in a sandboxed
|
|
# `nix build` like any other check.
|
|
vm-fast:
|
|
needs: discover
|
|
if: github.repository == 'LGUG2Z/komorebi-for-kde' && needs.discover.outputs.fast != '[]'
|
|
runs-on: ubuntu-24.04
|
|
timeout-minutes: 45
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
suite: ${{ fromJson(needs.discover.outputs.fast) }}
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
- uses: ./.github/actions/nix
|
|
with:
|
|
kvm: "true"
|
|
- run: nix build -L .#checks.x86_64-linux.vm-${{ matrix.suite }}
|
|
|
|
# The suites that draw and move a pointer. They run on master, every week, and on a pull
|
|
# request with the label `ci:vm-slow`. The driver is run by hand, outside the sandbox, so that
|
|
# the screenshots and the journals of a failed run can be uploaded.
|
|
vm-slow:
|
|
needs: discover
|
|
if: >-
|
|
github.repository == 'LGUG2Z/komorebi-for-kde' && needs.discover.outputs.slow != '[]' &&
|
|
(github.ref == 'refs/heads/master' || github.event_name == 'schedule' ||
|
|
github.event_name == 'workflow_dispatch' ||
|
|
contains(github.event.pull_request.labels.*.name, 'ci:vm-slow'))
|
|
runs-on: ubuntu-24.04
|
|
timeout-minutes: 60
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
suite: ${{ fromJson(needs.discover.outputs.slow) }}
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
- uses: ./.github/actions/nix
|
|
with:
|
|
kvm: "true"
|
|
- run: nix build -L .#legacyPackages.x86_64-linux.vm.${{ matrix.suite }}.driver -o driver
|
|
- run: mkdir -p out && cd out && ../driver/bin/nixos-test-driver -o .
|
|
- if: always()
|
|
uses: actions/upload-artifact@v7
|
|
with:
|
|
name: vm-${{ matrix.suite }}-${{ github.sha }}
|
|
path: out/
|
|
retention-days: 7
|
|
|
|
# The flake follows the tip of nixpkgs-unstable, so KWin and Plasma change under it whenever
|
|
# flake.lock moves. Every week, and on a manual run, this job moves nixpkgs to the tip in a copy
|
|
# of the checkout and builds every check against it, the VM suites of both tiers included, one
|
|
# after the other on one machine, so that komorebi and the guests are built once. When a check
|
|
# fails, it opens an issue, or comments on the one that is open. Nothing is pushed: the new lock
|
|
# exists only in the copy.
|
|
canary:
|
|
if: >-
|
|
github.repository == 'LGUG2Z/komorebi-for-kde' &&
|
|
(github.event_name == 'schedule' || github.event_name == 'workflow_dispatch')
|
|
runs-on: ubuntu-24.04
|
|
timeout-minutes: 360
|
|
permissions:
|
|
contents: read
|
|
issues: write
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
with:
|
|
persist-credentials: false
|
|
- uses: ./.github/actions/nix
|
|
with:
|
|
kvm: "true"
|
|
cache: "false"
|
|
- name: Move nixpkgs to the tip in a copy of the checkout
|
|
run: |
|
|
cp -a . "$RUNNER_TEMP/canary"
|
|
cd "$RUNNER_TEMP/canary"
|
|
locked=$(nix eval --raw --inputs-from . nixpkgs#kdePackages.kwin.version)
|
|
nix flake update nixpkgs
|
|
rev=$(jq -r .nodes.nixpkgs.locked.rev flake.lock)
|
|
echo "NIXPKGS_REV=$rev" >>"$GITHUB_ENV"
|
|
tip=$(nix eval --raw --inputs-from . nixpkgs#kdePackages.kwin.version)
|
|
echo "KWIN=$tip (flake.lock has $locked)" >>"$GITHUB_ENV"
|
|
- id: build
|
|
name: Build every check against it
|
|
working-directory: ${{ runner.temp }}/canary
|
|
run: |
|
|
failed="$RUNNER_TEMP/canary-failed"
|
|
: >"$failed"
|
|
# the checks that need no virtual machine, as the lint job lists them, then the suites
|
|
# of both tiers, as the discover job lists them
|
|
checks=$(nix eval --json .#checks.x86_64-linux --apply builtins.attrNames |
|
|
jq -r '(.[] | select(startswith("vm-") | not)), "vm-lib"')
|
|
suites=$(nix eval --json .#legacyPackages.x86_64-linux.vmTiers |
|
|
jq -r '(.fast // []) + (.slow // []) | .[] | "vm-" + .')
|
|
for check in $checks $suites; do
|
|
echo "::group::$check"
|
|
nix build -L --no-link ".#checks.x86_64-linux.$check" || echo "$check" >>"$failed"
|
|
echo "::endgroup::"
|
|
done
|
|
test ! -s "$failed"
|
|
- name: Report
|
|
if: always()
|
|
env:
|
|
BUILD: ${{ steps.build.outcome }}
|
|
RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
|
|
run: |
|
|
failed="$RUNNER_TEMP/canary-failed"
|
|
{
|
|
echo "- commit: $GITHUB_SHA"
|
|
if [ -n "${NIXPKGS_REV:-}" ]; then
|
|
echo "- nixpkgs-unstable:" \
|
|
"[\`${NIXPKGS_REV:0:12}\`](https://github.com/NixOS/nixpkgs/commit/$NIXPKGS_REV)${KWIN:+, with KWin $KWIN}"
|
|
else
|
|
echo "- nixpkgs-unstable: the update of flake.lock failed"
|
|
fi
|
|
echo
|
|
if [ -s "$failed" ]; then
|
|
echo "These failed:"
|
|
echo
|
|
while read -r check; do echo "- \`$check\`"; done <"$failed"
|
|
elif [ "$BUILD" = success ]; then
|
|
echo "Every check passed."
|
|
else
|
|
echo "The job failed before it could build the checks."
|
|
fi
|
|
echo
|
|
echo "The logs are in [the run]($RUN_URL)."
|
|
} >"$RUNNER_TEMP/canary.md"
|
|
cat "$RUNNER_TEMP/canary.md" >>"$GITHUB_STEP_SUMMARY"
|
|
- name: Open or update the canary issue
|
|
if: failure()
|
|
env:
|
|
GH_TOKEN: ${{ github.token }}
|
|
run: |
|
|
title="Canary: a check fails against the tip of nixpkgs-unstable"
|
|
number=$(gh issue list --repo "$GITHUB_REPOSITORY" --state open --limit 1000 \
|
|
--json number,title |
|
|
jq -r --arg title "$title" 'map(select(.title == $title)) | first | .number // empty')
|
|
if [ -n "$number" ]; then
|
|
gh issue comment "$number" --repo "$GITHUB_REPOSITORY" --body-file "$RUNNER_TEMP/canary.md"
|
|
else
|
|
gh issue create --repo "$GITHUB_REPOSITORY" --title "$title" \
|
|
--body-file "$RUNNER_TEMP/canary.md"
|
|
fi
|