Skip to content

Publish the release when a version tag is pushed - #3

Open
28spawn wants to merge 1 commit into
mainfrom
ci/release-workflow
Open

28spawn wants to merge 1 commit into
mainfrom
ci/release-workflow

Conversation

@28spawn

@28spawn 28spawn commented Nov 10, 2026

Copy link
Copy Markdown
Owner

Why

v0.1.1 was merged into main with nothing published under Releases. The release commit (5e50b71) builds the package and commits it to custom-fw/release/Icarus_0.11/, but no tag was created and no GitHub release was made — and the repository had no .github/workflows directory at all, so there was no automation to catch it. v0.1.1 has now been tagged and published manually; this PR makes the next one automatic.

What it does

On a push of a v* tag (or a manual run):

  1. Resolves the package folder from the tag. The firmware keeps its minor version in two digits and the tag's minor and patch digits concatenate into it: v0.1.1 -> Icarus_0.11, v0.1.0 -> Icarus_0.10, v1.0.5 -> 1.05.
  2. Verifies SHA256SUMS against every listed file. A mismatch aborts the release — nothing is published.
  3. Creates the GitHub release with the package assets, pre-release by default.

Why it publishes the committed package instead of rebuilding

The firmware is built with the proprietary JieLi pi32 toolchain (C:\JL\pi32), which is not available on the GitHub-hosted runners, so CI cannot produce the .bin/.fwsc. custom-fw\build.ps1 does the build locally and the package is committed with the release commit; this workflow publishes exactly that checksum-verified payload. The release process is documented in the header of the workflow file.

Release process from now on

  1. Bump PA_FW_VERSION in custom-fw/include/pa_config.h (11u -> 12u means 0.12).
  2. Run custom-fw\build.ps1. It writes custom-fw/release/Icarus_<ver>/.
  3. Commit the new package and its SHA256SUMS with the version bump.
  4. Merge, then push the tag:
git tag -a v0.1.2 -m "Icarus v0.1.2" <release commit>
git push origin v0.1.2

Pushing the tag publishes the release. A release commit can no longer land on main with nothing published.

Tested

  • The YAML parses and the tag resolution was run against the real v0.1.0 and v0.1.1 trees: both resolve to the right folder and the right four assets.
  • The checksum gate was verified by flipping one byte in a package: the workflow aborts with a SHA256 mismatch and publishes nothing.
  • A tag with no committed package fails with a message naming the packages that do exist, rather than publishing an empty release.

v0.1.1 was merged into main with nothing published under Releases: the
release commit builds the package and commits it to
custom-fw/release/Icarus_0.11/, but nothing ever created the tag or the
GitHub release, and the repository had no .github/workflows directory at
all, so there was no automation to do it.

This workflow publishes a release when a v* tag is pushed. It resolves the
package folder from the tag (v0.1.1 -> Icarus_0.11, the minor and patch
digits concatenate into the firmware's two-digit minor), verifies
SHA256SUMS, and creates the release with the assets.

It publishes the committed package rather than rebuilding, because the
firmware needs the proprietary JieLi pi32 toolchain (C:\\JL\\pi32), which
the GitHub runners do not have. custom-fw\\build.ps1 does the build
locally and the package is committed with the release commit.

Also supports a manual run, and prefers a per-package RELEASE_NOTES.md
when the package carries one.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant