Tune Discord announce for synapse (compare link + footer; drop reusable framing)#21
Merged
Merged
Conversation
… + footer) Per-product is the right call — a shared/reusable action across synapse/nimblebrain/mpak was premature abstraction. Make this synapse's own announce, optimized for a code-dense dev-SDK changelog. - Drop the "transport-agnostic / will move to a shared action" framing from the script; it's synapse-specific by design now. - Add a compare-diff link (Changelog vPrev…vCur) next to the release-notes link — computed from the previous published tag (omitted on first release). Devs want the diff. - Add an embed footer (`@nimblebrain/synapse`, the npm package) + the release timestamp, mirroring how a good release post anchors itself. - Keep the first-sentence teaser (right for synapse's pill-heavy notes) and the NimbleBrain Releases identity.
QA flagged that the previous-tag selection (newest non-current published release) would produce a backwards compare link for an out-of-order backport. That can't happen on single-track synapse and fails only cosmetically, so this documents the assumption (and the sort -V escape hatch) rather than adding speculative robustness for a case that won't occur.
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
1 participant
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.
Follow-up to #20, prompted by comparing our release posts against a fuller-digest style seen elsewhere.
Decision: per-product, not a shared action. A reusable action across synapse/nimblebrain/mpak was premature abstraction. This makes the announce synapse's own, tuned to a code-dense dev-SDK changelog. Other products will get their own, tuned to their changelog style.
Changes
[Changelog vPrev…vCur →]alongside the release-notes link, computed from the previous published tag (omitted cleanly on a first release). The diff is the one thing a fuller-digest post surfaces that devs actually want.@nimblebrain/synapse(the npm package, so the install target is right there) and the release time.NimbleBrain Releasesidentity.What we deliberately did not adopt: full-body section/bullet rendering. That works for user-facing prose notes; against synapse's code-dense CHANGELOG it reproduces the wall-of-pills we already removed.
Rendered (v0.10.2)
Verified (dry-run)
::warning::+ generic copy.