mirror of
https://github.com/rstrouse/ESPSomfy-RTS.git
synced 2026-11-20 15:52:12 +01:00
ci: review fixes for the release job and set_version.sh
- set_version.sh: three of its four patterns only matched digits and dots, so FW_VERSION and index.js stayed at v4.0.0.beta and index.html at ?v=3.0.14d. They now match any version, and the script fails when a file doesn't end up with the new one. test/scripts/test_set_version.sh covers it and runs with the native tests. - Release job: each build's files are collected from its own folder, with 4 files each and no name in two builds, before they're signed. The version bump is made on the release's branch as it is now, not the tag, so a merge during the builds doesn't reject the push. - Scorecard reports to code scanning only: publishing from a fork isn't supported, so no badge. - New workflows renamed to .yaml like build.yaml. SECURITY.md: the routes open in Secured mode, and which jobs can write what. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
parent
5c57d1a2cd
commit
787cebdb18
9 changed files with 124 additions and 18 deletions
23
.github/set_version.sh
vendored
23
.github/set_version.sh
vendored
|
|
@ -1,6 +1,7 @@
|
|||
#!/usr/bin/env bash
|
||||
# Writes a release's version into the sources: bash .github/set_version.sh v4.0.1
|
||||
# The build jobs build with it, the release job commits it.
|
||||
# Tested by test/scripts/test_set_version.sh.
|
||||
set -euo pipefail
|
||||
|
||||
VERSION="${1#v}"
|
||||
|
|
@ -11,7 +12,21 @@ if [[ ! "$VERSION" =~ ^[0-9]+(\.[0-9A-Za-z-]+)*$ ]]; then
|
|||
exit 1
|
||||
fi
|
||||
|
||||
sed -i "s/#define FW_VERSION \"v[0-9.]*\"/#define FW_VERSION \"v${VERSION}\"/" src/ConfigSettings.h
|
||||
sed -i "s/^[0-9.].*/${VERSION}/" data-src/appversion
|
||||
sed -i "s/\?v=[0-9.]*c/?v=${VERSION}c/g" data-src/index.html
|
||||
sed -i "s/appVersion = 'v[0-9.]*'/appVersion = 'v${VERSION}'/" data-src/index.js
|
||||
# Each pattern matches whatever version is there now, suffixes included
|
||||
# (v4.0.0.beta, ?v=3.0.14d). The ?v= suffix letter busts the browser cache.
|
||||
sed -i "s/#define FW_VERSION \"v[^\"]*\"/#define FW_VERSION \"v${VERSION}\"/" src/ConfigSettings.h
|
||||
sed -i "s/^[0-9].*/${VERSION}/" data-src/appversion
|
||||
sed -i "s/[?]v=[0-9][0-9A-Za-z.-]*/?v=${VERSION}c/g" data-src/index.html
|
||||
sed -i "s/appVersion = 'v[^']*'/appVersion = 'v${VERSION}'/" data-src/index.js
|
||||
|
||||
# sed succeeds when nothing matches, so check each file got the version.
|
||||
check() {
|
||||
if ! grep -qF -- "$2" "$1"; then
|
||||
echo "$1 doesn't have $2: its version string changed shape" >&2
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
check src/ConfigSettings.h "#define FW_VERSION \"v${VERSION}\""
|
||||
check data-src/appversion "${VERSION}"
|
||||
check data-src/index.html "?v=${VERSION}c"
|
||||
check data-src/index.js "appVersion = 'v${VERSION}'"
|
||||
|
|
|
|||
35
.github/workflows/build.yaml
vendored
35
.github/workflows/build.yaml
vendored
|
|
@ -38,6 +38,9 @@ jobs:
|
|||
- name: Run native unit tests
|
||||
run: pio test -e coverage
|
||||
|
||||
- name: Test the release scripts
|
||||
run: bash test/scripts/test_set_version.sh
|
||||
|
||||
# gcovr.cfg picks the files; the table goes to the run's summary page.
|
||||
- name: Coverage report
|
||||
run: |
|
||||
|
|
@ -66,7 +69,7 @@ jobs:
|
|||
uses: actions/setup-node@249970729cb0ef3589644e2896645e5dc5ba9c38 # v6.5.0
|
||||
with:
|
||||
node-version: "22"
|
||||
# No cache: a release build must not pick up what a PR left in one.
|
||||
# Never cache: this workflow also builds releases.
|
||||
package-manager-cache: false
|
||||
|
||||
# The protocol 2 client (data-src/js) against the recorded fixtures.
|
||||
|
|
@ -337,8 +340,28 @@ jobs:
|
|||
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
|
||||
with:
|
||||
pattern: release-*
|
||||
path: dist
|
||||
merge-multiple: true
|
||||
path: artifacts
|
||||
|
||||
# One folder per build. Each must hold its 4 files, and no build may
|
||||
# replace another's file, so nothing unexpected gets signed.
|
||||
- name: Collect release files
|
||||
run: |
|
||||
mkdir dist
|
||||
for d in artifacts/release-*/; do
|
||||
count=$(find "$d" -type f | wc -l)
|
||||
if [ "$count" -ne 4 ]; then
|
||||
echo "::error::$d has $count files, not 4"
|
||||
exit 1
|
||||
fi
|
||||
for f in "$d"*; do
|
||||
name=$(basename "$f")
|
||||
if [ -e "dist/$name" ]; then
|
||||
echo "::error::$name comes from two builds"
|
||||
exit 1
|
||||
fi
|
||||
cp "$f" dist/
|
||||
done
|
||||
done
|
||||
|
||||
- name: Checksums
|
||||
working-directory: dist
|
||||
|
|
@ -361,9 +384,12 @@ jobs:
|
|||
TAG: ${{ github.event.release.tag_name }}
|
||||
run: gh release upload "$TAG" dist/* --clobber --repo "$GITHUB_REPOSITORY"
|
||||
|
||||
# The release's branch as it is now, not the tag: main may have moved
|
||||
# on while the boards built.
|
||||
- name: Check out code
|
||||
uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
|
||||
with:
|
||||
ref: ${{ github.event.release.target_commitish }}
|
||||
persist-credentials: true # pushes the version bump
|
||||
|
||||
- name: Commit version update
|
||||
|
|
@ -374,6 +400,5 @@ jobs:
|
|||
bash .github/set_version.sh "$TAG"
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
git add src/ConfigSettings.h data-src/appversion data-src/index.html data-src/index.js
|
||||
git commit -m "chore: bump version to $TAG"
|
||||
git commit -am "chore: bump version to $TAG"
|
||||
git push origin "HEAD:$TARGET"
|
||||
|
|
|
|||
|
|
@ -2,7 +2,9 @@ name: Scorecard
|
|||
|
||||
# OpenSSF Scorecard: rates the repo's supply chain practices (pinned
|
||||
# dependencies, token permissions, branch protection, code review, ...).
|
||||
# Results go to Security > Code scanning and to the README badge.
|
||||
# Results go to Security > Code scanning. They aren't published to
|
||||
# scorecard.dev (no badge): scorecard-action doesn't support publishing
|
||||
# from a fork.
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
|
|
@ -18,7 +20,6 @@ jobs:
|
|||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
security-events: write # the results to code scanning
|
||||
id-token: write # publishing the results for the badge
|
||||
|
||||
steps:
|
||||
- name: Check out code
|
||||
|
|
@ -31,7 +32,7 @@ jobs:
|
|||
with:
|
||||
results_file: results.sarif
|
||||
results_format: sarif
|
||||
publish_results: true
|
||||
publish_results: false
|
||||
|
||||
- name: Upload to code scanning
|
||||
uses: github/codeql-action/upload-sarif@9b3254085494b55a0f7c4c2b3d2d52cc712ce370 # v4.39.1
|
||||
Loading…
Add table
Add a link
Reference in a new issue