Repository navigation
Engine module tag #1165
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Engine module tag | |
| # Publishing a platform engine module is one command: push a lib/<platform>/vX tag. | |
| # There is no build to fail and no registry to reject it — the module proxy simply | |
| # serves whatever that tag points at, forever, and will not serve different bytes | |
| # for it afterwards. A tag that names the wrong engine cannot be corrected, only | |
| # superseded by a version that no longer means what it says. | |
| # | |
| # verify-embedded-engine.sh already checks any lib/* tag sitting on the commit, but | |
| # a CI checkout carries no tags, so in practice that check only ever runs on the | |
| # machine doing the publishing — which is the machine that just typed the tag. This | |
| # runs on the push itself, so the tag is checked whether or not whoever pushed it | |
| # ran anything locally. | |
| # | |
| # It cannot refuse the push. What it can do is fail loudly within a minute, while | |
| # deleting and re-pushing the tag is still cheap: the proxy caches on first fetch, | |
| # so a wrong tag nobody has fetched yet can still be taken back. | |
| on: | |
| push: | |
| tags: ['lib/**'] | |
| # A push carrying more than three tags creates no event at all — not a partial | |
| # one — and a release is four platform tags. package-engine.sh prints one push | |
| # per tag for that reason, but an instruction is not a guarantee, and this check | |
| # is worthless if the one release that skips it is the one that was wrong. So | |
| # every published tag is re-checked on a schedule regardless of how it arrived, | |
| # including tags that predate this workflow. | |
| schedule: | |
| - cron: '17 * * * *' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| jobs: | |
| tag_names_its_engine: | |
| if: github.event_name == 'push' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version: "1.21" | |
| - name: The tag has to name the engine the module was built from | |
| run: go run ./scripts/enginetag -verify "${{ github.ref_name }}" | |
| every_published_tag: | |
| if: github.event_name != 'push' | |
| runs-on: ubuntu-latest | |
| steps: | |
| # blob:none because the tags carry the engine payloads: a full clone would | |
| # pull every version ever published to read one small generated file from | |
| # each. The blobs actually needed are fetched on demand below. | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| filter: blob:none | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version: "1.21" | |
| - name: Every lib/* tag has to name the engine its module was built from | |
| run: | | |
| set -uo pipefail | |
| tags=$(git tag --list 'lib/*') | |
| if [ -z "$tags" ]; then | |
| echo "no engine module tags published yet" | |
| exit 0 | |
| fi | |
| failed=0 | |
| for tag in $tags; do | |
| moddir=${tag%/*} | |
| metadata="$moddir/engine_data.go" | |
| if [ "${moddir##*/}" = "embedded" ]; then | |
| metadata="$moddir/go.mod" | |
| fi | |
| # The metadata as it is at that tag, not as it is on the default | |
| # branch, which carries placeholders. | |
| if ! git checkout -q "$tag" -- "$metadata" 2>/dev/null; then | |
| echo "::error::$tag has no $metadata" | |
| failed=1 | |
| continue | |
| fi | |
| go run ./scripts/enginetag -verify "$tag" || failed=1 | |
| git checkout -q HEAD -- "$metadata" | |
| done | |
| exit "$failed" |