Files
logpile/bible-local/08-build-release.md
T
Mikhail ChusavitinandClaude Opus 5.5 cb2e38223e chore: update parser module to v38.0.0, script parser bumps
Move logpile to git.mchus.pro/reanimator/parser/v38 v38.0.0 (ADL-085).
Add scripts/bump-parser.sh, which bumps the parser, tests, commits, tags
the release as v<counter>.<parser major>, pushes and builds (ADL-086).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-26 18:07:28 +03:00

116 lines
4.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 08 — Build & Release
## CLI flags
Defined in `cmd/logpile/main.go`:
| Flag | Default | Purpose |
|------|---------|---------|
| `--port` | `8082` | HTTP server port |
| `--file` | empty | Preload archive file |
| `--sanitize` | empty | De-identify customer data in this file and exit (`docs/log-sanitization.md`) |
| `--sanitize-out` | empty | Where `--sanitize` writes its result (default: overwrite the input) |
| `--version` | `false` | Print version and exit |
| `--no-browser` | `false` | Do not auto-open browser |
| `--hold-on-crash` | `true` on Windows | Keep console open after fatal crash |
## Common commands
```bash
make build
make build-all
make test
make fmt
```
Notes:
- `make build` outputs `bin/logpile`
- `make build-all` builds the supported cross-platform binaries
## Private module dependency
logpile depends on `git.mchus.pro/reanimator/parser/v38` (archive parsing, Redfish
replay/analysis, `models`, `pciids` — see ADL-080 in `10-decisions.md`), a private Gitea
host. `git.mchus.pro` has no public Go checksum database entry, so a clean module cache
needs `GOPRIVATE=git.mchus.pro/*` set before `go mod tidy`/`go build`/`go get` can
resolve it (`go env -w GOPRIVATE=git.mchus.pro/*`), or a `go.sum` seeded from another
project that already depends on the same version. This is logpile's first non-replaced
external Go module dependency — CI must set `GOPRIVATE` accordingly.
PCI vendor/device ID data (`pci.ids`) now lives inside that module; logpile no longer
embeds its own copy or carries the `third_party/pciids` submodule.
## Release script
Run:
```bash
./scripts/release.sh
```
Current behavior:
1. Reads version from `git describe --tags`
2. Refuses a dirty tree unless `ALLOW_DIRTY=1`
3. Sets stable Go cache/toolchain environment
4. Creates `releases/{VERSION}/`
5. Creates a release-notes template if missing
6. Builds `darwin-arm64` and `windows-amd64`
7. Packages any already-present binaries from `bin/`
8. Generates `SHA256SUMS.txt`
Release tag format (ADL-086):
- project release tags use `vC.P`: `C` is the release counter (highest `N` among existing
`vN.M` tags + 1), `P` is the major version of the parser module the release is built with
- example: `v2.49` (last old-style tag) -> `v3.38` (parser v38) -> `v4.38` -> `v5.39`
- do not create `vN.M.P` tags for LOGPile releases
- release artifacts and `main.version` inherit the exact git tag string
## Parser bump script
```bash
./scripts/bump-parser.sh
```
Moves logpile to the latest published parser tag without manual edits:
1. Refuses a dirty tree (except with `DRY_RUN=1`)
2. Pulls the local parser checkout `../reanimator/parser` if present and clean (best effort)
3. Finds the latest `vX.Y.Z` tag on `https://git.mchus.pro/reanimator/parser.git`
(override: `PARSER_VERSION=v38.0.0`); exits if already on it (unless `FORCE=1`)
4. Rewrites `git.mchus.pro/reanimator/parser/vOLD` -> `/vNEW` in `cmd/`, `internal/`
(not `internal/chart`) and `bible-local/` (not `10-decisions.md`), updates `go.mod`,
runs `go mod tidy`
5. Runs `go build`, `go vet`, `go test` on `./...`
6. Computes the next `vC.P` tag from local + `origin` tags
7. Commits `chore: update parser module to vX.Y.Z` on the current branch, creates an
annotated tag, pushes branch and tag (`NO_PUSH=1` skips the push)
8. Runs `make build` so `bin/logpile` carries the new tag
`DRY_RUN=1` does steps 1–6 and builds, but leaves changes uncommitted.
Routine parser bumps made by this script do not need their own ADL entry; record one only
when logpile code or behavior has to change for the new parser.
Important limitation:
- `scripts/release.sh` does not run `make build-all` for you
- if you want Linux or additional macOS archives in the release directory, build them before running the script
Toolchain note:
- `scripts/release.sh` defaults `GOTOOLCHAIN=local` to use the already installed Go toolchain and avoid implicit network downloads during release builds
- if you intentionally want another toolchain, pass it explicitly, for example `GOTOOLCHAIN=go1.24.0 ./scripts/release.sh`
## Run locally
```bash
./bin/logpile
./bin/logpile --port 9090
./bin/logpile --no-browser
./bin/logpile --version
```
## macOS Gatekeeper
```bash
xattr -d com.apple.quarantine /path/to/logpile-darwin-arm64
```