Files

T

Build PCM package / build (push) Successful in 9s

Details

Release notes come from a file in the repo, not the tag

Deriving the body from the tag annotation does not survive CI: the
release action does not fall back to it (v1.2.0 published empty), and
checkout leaves the tag lightweight, so %(contents) yields the commit
message instead - which is what v1.2.1 first published. Keep the notes
at docs/release-notes/v<version>.md, pass that as body_path, and fail
the run when it is missing.

2026-07-22 16:27:31 +07:00

2.7 KiB

Raw Blame History

Releasing a new version

The PCM addon zip is built by CI (.gitea/workflows/build-pcm.yml). Every push to main builds it as a downloadable artifact; pushing a v<version> tag additionally creates a Gitea release with the zip attached. The release job checks that the tag matches metadata.json and that the release notes exist, and fails on either mismatch.

Steps

Bump the version in metadata.json — the single entry in versions (plain MAJOR.MINOR.PATCH, no v prefix; the PCM schema rejects anything else):

"versions": [
    {
        "version": "1.0.2",
        "status": "stable",
        "kicad_version": "10.0",
        "runtime": "ipc"
    }
]

Write the release notes at docs/release-notes/v<version>.md. This file becomes the release description verbatim; the job fails if it is missing or empty (the release action publishes empty notes rather than falling back to the tag message, which is how v1.2.0 shipped with a blank description). Say what changed for a user of the previous version — in particular, whether results move for an unchanged board.

Commit, tag, push (tag = v + the manifest version):

git add metadata.json docs/release-notes/v1.0.2.md
git commit -m "Release 1.0.2"
git tag v1.0.2
git push
git push origin v1.0.2

Verify: the Actions run for the tag builds th.co.b4l.fill-resistance_<version>.zip and publishes it at https://git.b4l.co.th/B4L/kicad-zone-resistance/releases, together with metadata-registry.json. The zip installs directly via Plugin and Content Manager → Install from File.

Publishing to the official KiCad registry (optional)

The attached metadata-registry.json already carries the release download_url, download_sha256 and sizes. Submit it as packages/th.co.b4l.fill-resistance/metadata.json in a merge request to https://gitlab.com/kicad/addons/metadata. The registry keeps every published version: append the new entry to the versions array of the registry copy instead of replacing the previous one (the repo's own metadata.json only ever holds the current version — tools/build_package.py reads versions[0]).

Local build (no CI)

python tools/build_package.py    # writes dist/<identifier>_<version>.zip

Pure stdlib — no venv needed. dist/ is gitignored.

CI prerequisites (one-time, server side)

Actions enabled for the repo (Settings → Actions unit).
A runner registered with the ubuntu-latest label; the default act_runner image works — the build needs only Python 3.
Workflow actions are pinned to commit SHAs; when bumping them, update the SHA and the trailing version comment together.

2.7 KiB Raw Blame History