Skip to content

Commit d3e9a10

Browse files
committed
docs: correct stale NIF checksum-verification comment
release-nif.yml's header said consumers verify tarballs against the release .sha256 sidecar, but the actual trust model pins SHA256s in native_checksums.txt (shipped in the hex package). Align the comment with MAINTAINING.md; the sidecars are informational only.
1 parent dcb4cf8 commit d3e9a10

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

.github/workflows/release-nif.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,13 @@ name: Release NIF
1313
# tag. Artefacts go to workflow run storage (retention 90 days);
1414
# no GitHub release is touched.
1515
#
16-
# Consumers verify each tarball against the sidecar fetched from
17-
# the same release, so there is no checksum list to bake into
18-
# mix.exs on the maintainer side.
16+
# Consumers verify each tarball against the SHA256 pinned in
17+
# `native_checksums.txt`, which ships inside the hex package (and is
18+
# thus covered by Hex's package hash in the consumer's mix.lock — a
19+
# trust root independent of the mutable GitHub release). The maintainer
20+
# regenerates that file with `mix emily.publish` once the release is
21+
# public; the `.sha256` sidecars uploaded here are informational only.
22+
# See MAINTAINING.md.
1923

2024
on:
2125
push:

0 commit comments

Comments
 (0)