Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
358 changes: 358 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

32 changes: 32 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Releasing

A release is a signed tag `vX.Y.Z` on a commit of `main`. The `release`
workflow runs on the tag: it builds the static binaries for x86_64 and
aarch64, tests each on its own architecture, checks the version line against
the tag, and publishes the binaries with `SHA256SUMS`, software bills of
materials and build provenance attestations.

`cog bump` does the mechanical part. `cog.toml` runs `tools/release-prepare`
before the bump commit, which builds `CHANGELOG.md` from `changelog.d/` with
towncrier and sets the version wherever a program prints it or a download
names it; the script's header lists the files.

## Steps

1. Branch from `main`: `git switch -c chore/release-X.Y.Z origin/main`.
2. Edit the prose that names the previous release, in a commit of its own:
the paragraph of `docs/orgmode/howto/install.org` that says what the
previous release lacks, and the list of options added since it in
`docs/orgmode/reference/cli.org`.
3. `cog bump --minor` (or `--patch`, `--major`, `--version X.Y.Z`). It runs
the hook, commits `chore(version): X.Y.Z` and creates the tag on that
commit. `cog bump --minor --dry-run` prints the version only.
4. Push the branch, open the pull request, and merge it with a merge commit
once its checks pass, so the tagged commit is on `main`.
5. Push the tag: `git push origin vX.Y.Z`. To sign a tag cog left unsigned:
`git tag -s -f vX.Y.Z -m "eb-local X.Y.Z" vX.Y.Z^{}` before pushing.
6. Check the release: two binaries, `SHA256SUMS`, the `.cdx.json` files, and
`gh attestation verify FILE --repo stackhands/eb-local`.

A failed workflow leaves no release. Fix the cause, delete the tag locally
and on the remote, and tag again.
2 changes: 1 addition & 1 deletion build.zig.zon
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.{
.name = .eb_local,
.version = "3.1.0",
.version = "3.2.0",
.fingerprint = 0x512ce9ad65023f55,
.minimum_zig_version = "0.17.1",
.dependencies = .{
Expand Down
1 change: 0 additions & 1 deletion changelog.d/+api-reference.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+at-most-one.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-buildenv-flag-diagnostic.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-clean-duplicate-days-order.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-clean-logs-older-than-equals.bugfix.md

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-cli-c-match-locale.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-empty-equals-option-refusal.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-env-usage-message-parity.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-frozen.removal.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-legacy-conf-c-match-locale.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-legacy-conf-duplicate-keys.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-legacy-conf-single-pass.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-legacy-conf-table-validation.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-opt-value-empty-parity.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-project-before-subcommand.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-project-mkdir-hint-quoting.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-reject-extra-env-flag.bugfix.md

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+bash-script-version-outside-slurm.bugfix.md

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+build-cli-modes-tests.misc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+build-prefix-full-ro.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+build-secrets.feature.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+check-cli-flags-tests.misc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+check-compat-ld-conf.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+check-dev-escape-check.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+check-eprefix-trailing-slash.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+check-file-dedup.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+check-json-suppress-human-text.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+check-module-dedup.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+check-needed-origin.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+check-recursive.feature.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+check-reject-duplicate-prefix.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+check-target-trailing-slash.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+check-tree.feature.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+clean-cli-modes-tests.misc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+clean-json.feature.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+clean-logs-flag-validation.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+clean-readonly-partial.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+clean-respects-active-locks.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+clean-rtrash-put-failure-test.misc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+cli-assets-atomic-safe-writes.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+cli-assets-completions.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+cli-assets-escape-roff-dot.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+cli-assets-posix-bash-func-name.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+cli-assets.feature.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+cli-doctor-synopsis.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+cli-reference.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+cli-sync-main.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+concurrent-build-prefix-lock.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+config-cli-modes-tests.misc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+config-eessi-reserved-vars-test.misc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+config-empty-prefix-or-project.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+config-get-eessi-empty-exit-one.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+config-get.feature.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+config-open-errno.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+config-reject-duplicate-get.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+config-secret-refuse-shellopts.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+config-target-lines.bugfix.md

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+configuration-pointer.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+configuration-reference.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+cvmfs-empty-proxy-clears.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+cvmfs-inline-comment.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+cvmfs-parallel-probe-batch-reap.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+cvmfs-proxy-export-tab.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+cvmfs-proxy-trim-quoted-whitespace.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+dev-cli-modes-tests.misc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+dev-envrc.feature.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+dev-gcc-buildenv-slash-boundary.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+dev-host-ca-bundle.feature.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+dev-llvm.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+dev-lock.feature.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+dev-pure.feature.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+dev-strict.feature.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+diataxis-sections.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+doc-comments.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+docs-build.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+docs-cli-doctor-json-strict-exit.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+docs-cli-env-strict-option.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+docs-cli-json-reference-sync.doc.md

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+docs-export-empty-out-env.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+docs-export-howto-sync.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+docs-refusals-nospace-errno.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+docs-site-install-symlink-message.doc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+docs-toc-order.misc.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+doctor-bind-latest-localtime.bugfix.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+doctor-cli-modes-tests.misc.md

This file was deleted.

Loading
Loading