Files
product-template/release/README.md
T
grabowski 52a40c1c3e release/: the newest stage's manufacturing files and documentation
A stage tag (v*) now builds, with kicad-cli, pandoc and pdflatex in the CI
image (.gitea/scripts/release-files.py):
- per board: Gerbers + Excellon drill zip (JLCPCB-compatible settings), BOM
  (grouped, DNP left out), pick and place, schematic and PCB PDFs, 3D renders;
- docs/*.md and docs/tex/*.tex as PDF, tag and commit in the footer;
- release/README.md with tag, commit, ERC/DRC result, files, SHA-256 and the
  stage's CHANGELOG section.
Every file name carries the tag. release-attach.py attaches the files plus a
zip of the whole folder to the tag's release (replacing assets of an earlier
run); for the newest stage tag (not older stages, not pre-releases) the job
commits them to release/ on main with [skip ci].

.gitignore: !/release/ after Release/ (Windows matches it case-insensitively);
.gitattributes: release/** -text so the SHA-256 match on every checkout.
TEMPLATE.md: "Release files" section, rules and CI updated.

Tested in git.b4l.co.th/b4l/kicad10_auto_node with harNES's board and docs:
v0.1 committed, v0.0 and v0.2-rc.1 left release/ alone, v0.2 tagged on an
older commit landed on top of a moved main; uploads byte-exact against a stub
of the Gitea release API.
2026-10-16 18:50:01 +07:00

15 lines
667 B
Markdown

# Release files
The latest prototype stage of this product: its manufacturing files and its
documentation. CI (`.gitea/workflows/release.yml`) replaces this folder when a
stage tag (`v0.1`, `v0.2`, ...) is pushed:
- `hardware/<board>/`: Gerbers and drill files (zip), BOM, pick and place,
schematic and PCB PDFs, 3D renders of every board;
- `docs/`: `docs/*.md` and `docs/tex/*.tex` as PDF;
- this README: the tag, the commit, the ERC/DRC results, the file list with
SHA-256 and the stage's CHANGELOG section.
Empty until the first stage is tagged. Do not edit it by hand: the next tag
replaces it. Older stages are on the Releases page, with the same files.