Repository navigation
chore: float the sdlc gates on quay.io/crunchtools/sdlc #35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # The repo's own checks, from quay.io/crunchtools/sdlc -- the same image, the | ||
| # same launcher and the same commands the laptop's hooks run, so a green push | ||
| # predicts a green CI (constitution XII). Nothing here pins a release: the | ||
| # image prints its own launcher, and both float on :latest. | ||
| # | ||
| # The variable SDLC_IMAGE -- a repository's, or the organization's for the | ||
| # whole fleet -- picks other tooling: `main` for what has merged to python-sdlc | ||
| # and not been released, or a release such as `0.9.0` to hold one back. A | ||
| # variable, which only an admin sets, rather than a line a pull request could | ||
| # change in passing. | ||
| # | ||
| # Gourmand runs as its own job, not inside `sdlc ci`: XII has CI run push's | ||
| # checks except Gourmand and Gatehouse, which run through their own workflows | ||
| # (Gatehouse: gatehouse.yml). | ||
| # | ||
| # The job NAME `sdlc ci` is the required check in the org ruleset "Python SDLC | ||
| # gates", and the Gourmand job keeps the name its own workflow gave it. Renaming | ||
| # a job stops it gating, silently. | ||
| # | ||
| # python-sdlc's examples/ci.yml, written by scripts/convert_repo.py. Copy it | ||
| # unchanged. | ||
|
|
||
| name: CI | ||
|
|
||
| on: | ||
|
Check failure on line 25 in .github/workflows/ci.yml
|
||
| push: | ||
| branches: [main, master] | ||
| pull_request: | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| sdlc: | ||
| name: sdlc ci | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| persist-credentials: false | ||
|
|
||
| # .sdlc/bin/sdlc is python-sdlc's bin/sdlc-bootstrap: it asks the image | ||
| # for its launcher and runs it, as the hooks do. | ||
| - name: sdlc ci | ||
| env: | ||
| SDLC_IMAGE: ${{ vars.SDLC_IMAGE }} | ||
| run: .sdlc/bin/sdlc ci | ||
|
|
||
| gourmand: | ||
| name: Code Quality (Gourmand) | ||
| uses: crunchtools/gatehouse/.github/workflows/gourmand.yml@v0 | ||
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,36 @@ | ||
| # Every check runs from quay.io/crunchtools/sdlc (constitution XII). Nothing | ||
| # here pins it: .sdlc/bin/sdlc asks the image for its own launcher and runs it, | ||
| # so the launcher, the image and every tool inside it float together on | ||
| # :latest -- for this laptop and, through .github/workflows/ci.yml, for CI. | ||
| # There is no `rev:` to bump, ever. | ||
| # | ||
| # SDLC_IMAGE=main git push judges this push with what has merged to | ||
| # python-sdlc and not been released. A repo opts | ||
| # its CI in with the repository variable SDLC_IMAGE. | ||
| # | ||
| # What each hook runs is configured in pyproject.toml ([tool.sdlc.commit], | ||
| # [tool.sdlc.push], [tool.sdlc.ci]) or, in a repo with no pyproject.toml, | ||
| # sdlc.toml. `.sdlc/bin/sdlc tiers` prints it. | ||
| # | ||
| # `default_install_hook_types` must name both: without pre-push, `pre-commit | ||
| # install` wires only the commit hook and every verdict silently stops running. | ||
|
|
||
| default_install_hook_types: [pre-commit, pre-push] | ||
|
|
||
| repos: | ||
| - repo: local | ||
| hooks: | ||
| - id: gourmand | ||
| name: Gourmand (AI slop detection) | ||
| entry: podman --events-backend=none run --rm --log-driver=none -v .:/src:Z -w /src quay.io/crunchtools/gourmand:latest check --full | ||
| - id: sdlc-commit | ||
| name: sdlc commit | ||
| entry: .sdlc/bin/sdlc commit | ||
| language: system | ||
| pass_filenames: false | ||
| always_run: true | ||
| stages: [pre-commit, pre-merge-commit] | ||
| - id: gatehouse | ||
| name: Gatehouse (AI code review, staged diff) | ||
| entry: bash -c 'git diff --cached | podman --events-backend=none run --rm --log-driver=none -i --env-file "$HOME/.config/mcp-env/gatehouse.env" -v .:/src:ro,Z -w /src quay.io/crunchtools/gatehouse:latest --stdin' | ||
| - id: sdlc-push | ||
| name: sdlc push | ||
| entry: .sdlc/bin/sdlc push | ||
| language: system | ||
| pass_filenames: false | ||
| always_run: true | ||
| stages: [pre-commit, pre-merge-commit] | ||
| stages: [pre-push] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| #!/bin/sh | ||
| # Run `sdlc` with no `rev:` to pin: get the launcher from the image, then run it. | ||
| # | ||
| # The launcher (bin/sdlc) ships inside quay.io/crunchtools/sdlc, so it floats | ||
| # with the image tag exactly as the tools in the image do: `:latest` by | ||
| # default, SDLC_IMAGE=main for what has merged and not been released, a | ||
| # release such as SDLC_IMAGE=0.9.0, or SDLC_IMAGE=@sha256:<digest>. Nothing | ||
| # else: this file runs whatever it pulls, so it pulls from that one repository. | ||
| # A seat trying a local build runs a python-sdlc clone's bin/sdlc instead. The | ||
| # image prints the launcher with its own ref written into it (`sdlc launcher | ||
| # <ref>`), so the launcher and the image it starts cannot disagree. | ||
| # | ||
| # A converted repo carries this file as .sdlc/bin/sdlc, and its hooks and its | ||
| # CI job run it (scripts/convert_repo.py writes it). Nothing in it names a | ||
| # release, so nothing ever bumps it, and the constitution pins its bytes. An | ||
| # `sdlc` RPM would install the same file as /usr/bin/sdlc. | ||
| # | ||
| # Host contract: podman and POSIX sh, nothing else. Never a pipe into `sh`: a | ||
| # failed pull would hand sh nothing, and nothing runs and exits 0. An image | ||
| # that cannot print its launcher is a 2 -- the gate could not run. | ||
|
|
||
| set -u | ||
|
|
||
| FLEET=quay.io/crunchtools/sdlc | ||
| refuse() { | ||
| printf 'sdlc: GATE CANNOT RUN: SDLC_IMAGE=%s is not main, latest, X.Y.Z or @sha256:<64 hex> of %s\n' \ | ||
| "${SDLC_IMAGE:-}" "$FLEET" >&2 | ||
| exit 2 | ||
| } | ||
|
|
||
| # The value, with the repository named in full or not at all. | ||
| want=${SDLC_IMAGE:-latest} | ||
| case $want in | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. MEDIUM (Test Coverage): The new launcher has substantial untested branching: it accepts and normalizes several image-reference forms, rejects malformed tags and digests, handles Podman or launcher failures, and invokes the printed launcher with a checked image reference. No corresponding tests are included, leaving the gate’s image-selection and failure behavior unverified. Suggestion: Add tests using a stub Evidence:
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not a bug: .sdlc/bin/sdlc is the shared floating bootstrap, byte-identical in every repo and pinned by sha256 in constitution v1.46.0. Pulling sdlc:latest on each run is the design (python-sdlc 0.9.0). |
||
| "$FLEET":*) want=${want#"$FLEET":} ;; | ||
| "$FLEET"@*) want=${want#"$FLEET"} ;; | ||
| esac | ||
| case $want in | ||
| main|latest) image=$FLEET:$want ;; | ||
| @sha256:*) | ||
| hex=${want#@sha256:} | ||
| case $hex in *[!0-9a-f]*) refuse ;; esac | ||
| [ "${#hex}" -eq 64 ] || refuse | ||
| image=$FLEET$want ;; | ||
| *[!0-9.]*|.*|*.|*..*|*.*.*.*) refuse ;; | ||
| *.*.*) image=$FLEET:$want ;; | ||
| *) refuse ;; | ||
| esac | ||
|
|
||
| dir=$(mktemp -d) || exit 2 | ||
| trap 'rm -rf "$dir"' EXIT | ||
| trap 'exit 2' HUP INT TERM | ||
|
|
||
| # --pull=newer: :latest moves, and a stale local copy is how a two-week-old | ||
| # reviewer once judged trentina. Offline, podman keeps the copy it has. | ||
| if ! podman --events-backend=none run --rm --log-driver=none --network=none \ | ||
| --cap-drop=all --security-opt=no-new-privileges --pull=newer \ | ||
| -- "$image" launcher "$image" > "$dir/sdlc" || [ ! -s "$dir/sdlc" ]; then | ||
| printf 'sdlc: GATE CANNOT RUN: %s could not print its launcher\n' "$image" >&2 | ||
| exit 2 | ||
| fi | ||
| # The launcher reads SDLC_IMAGE too; it gets the full reference checked here. | ||
| SDLC_IMAGE=$image sh "$dir/sdlc" "$@" | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| [tool.sdlc.ci] | ||
| # Written by python-sdlc's scripts/convert_repo.py: the Containerfile needs | ||
| # build secrets (a secret mount, or RHSM) that `sdlc ci` is not given. The | ||
| # publish workflow still builds it, with them. | ||
| skip = ["container-build", "container-smoke", "container-scan"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
HIGH (Constitution): This workflow has no weekly cron trigger, despite the requirement that workflows include one for base image security updates.
Suggestion: Add a weekly
scheduletrigger to this workflow.Evidence:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a bug: ci.yml is the sdlc checks workflow (python-sdlc's examples/ci.yml, copied unchanged) and builds no image, so profile V's weekly rebuild does not apply to it. This image is rebuilt by container.yml, which the ubi10 cascade drives through
parent-image-updatedfrom ubi10-core's weekly cron.