docs: add the release checklist, the notes composer and a changelog - #18
Merged
Conversation
robrigo
force-pushed
the
docs/release-checklist
branch
from
August 17, 2026 20:59
41cef37 to
f263d1f
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.
Suppressed comments (2)
AUTHORS.md:12
- Avoid splitting the emphasized author handle across lines; keeping the bold span contiguous makes the rendered output more predictable.
Most of the v2 contract was authored by **t-break
([@on-a-t-break](https://github.com/on-a-t-break))**, and reached this
AUTHORS.md:7
- Avoid splitting bold text across a newline; it can render inconsistently depending on Markdown renderer. Consider keeping the emphasized name together and wrapping outside the ... span.
This issue also appears on line 11 of the same file.
current owner and maintainer. The v1 contract was written by **Jona Wilmsmann
(Pink Network)**.
Releases were cut by hand and each Release body was written in its own shape, so a deployer had to hunt for the checksums, the ABI compatibility statement and the deploy notes in a different place every time, and attribution repeated per release. RELEASING.md fixes the procedure: the CHANGELOG entry rides in the feature PR, the release build writes SHA256SUMS with bare asset names and its two rows land in the entry as the release commit, a preview runs before the tag, and the Release attaches the wasm, the abi and SHA256SUMS. scripts/release-notes.sh (the composer shared with atomicassets-api, copied unchanged with its paired test that CI now runs) composes the body from the entry at the tag plus the commit list since the previous release of the same kind and the compare link. CHANGELOG.md starts at 2.0.0 with the entry that matches the live v2.0.0 Release; the README points at both files and at AUTHORS.md, which carries the lineage the Release bodies used to repeat.
Contributor
Author
|
Round 2 suppressed notes on AUTHORS.md: applied, the two bold spans no longer wrap across a line. |
robrigo
force-pushed
the
docs/release-checklist
branch
from
August 17, 2026 21:04
f263d1f to
c40c777
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Releases of this contract were cut by hand and each body took its own shape, so a deployer hunted for the checksums, the ABI compatibility statement and the deploy notes in a different place every time.
RELEASING.mdfixes the procedure: the CHANGELOG entry rides in the feature PR, the release build writesSHA256SUMSwith bare asset names and its two rows land in the entry as the release commit, a preview runs before the tag, and the Release attachesatomicmarket.wasm,atomicmarket.abiandSHA256SUMS.scripts/release-notes.shcomposes the body from the entry at the tag plus the commit list since the previous release of the same kind and the compare link.CHANGELOG.mdstarts at 2.0.0 with the entry that matches the v2.0.0 Release now live, and attribution moves toAUTHORS.md. The existing Releases are already rewritten to this shape and the candidates retitled to their tags.Validation
The two scripts are byte-identical to the reviewed atomicassets-api files;
bash scripts/release-notes.test.shpasses 12/12 and CI runs it; shellcheck is clean.git rev-list --countconfirms the v2.0.0 range the live body lists, and a preview from a scratch branch carrying a draft entry composed the body as the checklist describes.