- auto-release.yml: the by-hand test run passes github.sha (what it got anyway) instead of an output that also reads workflow_run.head_sha, so CI never checks out a ref a workflow_run handed over in a job that uses caches (cache poisoning, 7 alerts in ci.yml). - tests/harness.js: the script splitter also matches end tags like </SCRIPT > (bad HTML filtering regexp). - Tests paste the fixture saves into the page with lit(), which escapes what could end a script or a string, instead of plain JSON.stringify (improper code sanitization).
117 lines
5.1 KiB
YAML
117 lines
5.1 KiB
YAML
name: Auto-release
|
|
|
|
# Bumping "version" in package.json on main is the release button: this tags
|
|
# v<version>, publishes a GitHub release with that version's CHANGELOG section
|
|
# as notes, and starts the deploy. Releases created with the workflow token do
|
|
# not fire the "released" event, so the deploy is started explicitly, from the
|
|
# tag, which keeps the github-pages environment's v* tag rule happy.
|
|
#
|
|
# It runs when CI finishes on main, so a release never repeats the push's tests:
|
|
# CI green on the commit that bumped the version is the go. A red CI releases
|
|
# nothing. Started by hand, it has no CI result to go by, so it tests first.
|
|
on:
|
|
workflow_run:
|
|
workflows: [CI]
|
|
types: [completed]
|
|
branches: [main]
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: write # create the tag and the release
|
|
actions: write # start the deploy workflow
|
|
|
|
concurrency:
|
|
group: auto-release
|
|
cancel-in-progress: false
|
|
|
|
jobs:
|
|
check:
|
|
# After CI: only a green run of a push to main (not a PR's run, not a release's own call).
|
|
if: >-
|
|
github.event_name == 'workflow_dispatch' ||
|
|
(github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'push')
|
|
runs-on: ubuntu-latest
|
|
env:
|
|
GH_TOKEN: ${{ github.token }}
|
|
outputs:
|
|
skip: ${{ steps.v.outputs.skip }}
|
|
ver: ${{ steps.v.outputs.ver }}
|
|
tag: ${{ steps.v.outputs.tag }}
|
|
pre: ${{ steps.v.outputs.pre }}
|
|
# The commit CI tested (main may have moved on since); by hand, main as it is now.
|
|
sha: ${{ github.event.workflow_run.head_sha || github.sha }}
|
|
steps:
|
|
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
with:
|
|
ref: ${{ github.event.workflow_run.head_sha || github.sha }}
|
|
fetch-depth: 0
|
|
|
|
- name: Work out the version and whether it is new
|
|
id: v
|
|
run: |
|
|
set -euo pipefail
|
|
ver=$(node -p "require('./package.json').version")
|
|
tag="v$ver"
|
|
echo "ver=$ver" >> "$GITHUB_OUTPUT"
|
|
echo "tag=$tag" >> "$GITHUB_OUTPUT"
|
|
if git ls-remote --exit-code --tags origin "refs/tags/$tag" >/dev/null; then
|
|
echo "$tag already exists, nothing to release."
|
|
echo "skip=true" >> "$GITHUB_OUTPUT"; exit 0
|
|
fi
|
|
latest=$(gh release list --repo "$GITHUB_REPOSITORY" --exclude-pre-releases --limit 1 --json tagName -q '.[0].tagName' || true)
|
|
latest="${latest#v}"
|
|
if [ -n "$latest" ] && [ "$(printf '%s\n%s\n' "$latest" "$ver" | sort -V | tail -n1)" != "$ver" ]; then
|
|
echo "::error::$ver is not newer than the latest release $latest"; exit 1
|
|
fi
|
|
awk -v v="$ver" 'index($0,"## ["v"]")==1{f=1;next} /^## \[/{f=0} f' CHANGELOG.md | sed -e '/./,$!d' > notes.md
|
|
if ! grep -q '[^[:space:]]' notes.md; then
|
|
echo "::error::CHANGELOG.md has no notes under ## [$ver]"; exit 1
|
|
fi
|
|
case "$ver" in *-*) echo "pre=true" >> "$GITHUB_OUTPUT";; *) echo "pre=false" >> "$GITHUB_OUTPUT";; esac
|
|
echo "skip=false" >> "$GITHUB_OUTPUT"
|
|
|
|
# Only when started by hand: after a push, CI has already tested this commit. By hand the commit is main as it is
|
|
# (github.sha, what check.outputs.sha is then), named directly so CI never checks out a ref a workflow_run handed over.
|
|
tests:
|
|
needs: check
|
|
if: needs.check.outputs.skip == 'false' && github.event_name == 'workflow_dispatch'
|
|
uses: ./.github/workflows/ci.yml
|
|
with:
|
|
ref: ${{ github.sha }}
|
|
|
|
release:
|
|
needs: [check, tests]
|
|
if: >-
|
|
always() && needs.check.result == 'success' && needs.check.outputs.skip == 'false' &&
|
|
(needs.tests.result == 'success' || needs.tests.result == 'skipped')
|
|
runs-on: ubuntu-latest
|
|
env:
|
|
GH_TOKEN: ${{ github.token }}
|
|
TAG: ${{ needs.check.outputs.tag }}
|
|
VER: ${{ needs.check.outputs.ver }}
|
|
PRE: ${{ needs.check.outputs.pre }}
|
|
SHA: ${{ needs.check.outputs.sha }}
|
|
steps:
|
|
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
with:
|
|
ref: ${{ needs.check.outputs.sha }}
|
|
|
|
- name: Publish the release
|
|
run: |
|
|
set -euo pipefail
|
|
awk -v v="$VER" 'index($0,"## ["v"]")==1{f=1;next} /^## \[/{f=0} f' CHANGELOG.md | sed -e '/./,$!d' > notes.md
|
|
pre=(); [ "$PRE" = "true" ] && pre=(--prerelease)
|
|
gh release create "$TAG" --repo "$GITHUB_REPOSITORY" \
|
|
--target "$SHA" --title "$VER" --notes-file notes.md "${pre[@]}"
|
|
|
|
- name: Deploy it
|
|
# Pre-releases are for testing and never go live. CI (or the tests above) already passed on this commit,
|
|
# so the deploy does not test it again (tested=true).
|
|
if: env.PRE == 'false'
|
|
run: gh workflow run release.yml --repo "$GITHUB_REPOSITORY" --ref "$TAG" -f tag="$TAG" -f tested=true
|
|
|
|
- name: Publish the Docker image
|
|
# Same pattern as the deploy above: the image is built and pushed from the
|
|
# release tag by docker.yml. Pre-releases get one too: an image tag is
|
|
# pulled on purpose, so a test image costs nothing.
|
|
run: gh workflow run docker.yml --repo "$GITHUB_REPOSITORY" --ref "$TAG" -f tag="$TAG"
|