Skip to content

What's new follows a release's notes when they are edited - #44

Merged
itsdoubleem merged 4 commits into
mainfrom
feat/notes-follow-release
Nov 9, 2026
Merged

itsdoubleem merged 4 commits into
mainfrom
feat/notes-follow-release

Conversation

@itsdoubleem

Copy link
Copy Markdown
Owner

What

Editing a release's notes on GitHub now updates the app page's "What's new" within the hour. Before, the site copied the notes once, when the version arrived, and kept them.

Why

The owner edited LOGGER 1.5.0's description and the site didn't follow it.

How

  • Fingerprint: each releases/<slug>.md records source:, a fingerprint of the GitHub text it was written from. When the release's text no longer matches, the hourly sync writes the file again, through the usual tested sync/candidate → main path.
  • Hand edits: a hand edit to the file lasts until the release's own text changes.
  • Refused edits: if edited notes are empty, or use a phrase npm run check refuses, the page keeps what it has, and one Issue (notes-<slug>) stays open until the notes are fixed. A new version with such notes is stopped for that app only. A rewrite uses the version in apps/<slug>.md, not the tag.

Testing

  • npm test: 117 pass (7 new). npm run build and npm run check pass.
  • The real sync, run against GitHub, rewrote LOGGER's 1.5.0 notes and left HANGIL alone. A second run changed nothing. Run without --issues; the file was reverted.
  • Review rounds 7 and 8. No must-fix or should-fix items are open.

Screenshots

None. After the merge, the hourly sync will update LOGGER's "What's new" with the owner's current 1.5.0 description. The owner chose to publish it as written.

Risks and rollback

  • Low. The worst case is a notes-only commit going through the sync's normal tested path.
  • Rollback: git revert the four commits.

The sync took a release's notes once, when the version arrived. Now each
releases/<slug>.md records a fingerprint of the GitHub text it came from
(source:), and an hourly run that finds the release's notes changed writes
the file again. A hand edit to the file lasts until the release text
changes; notes edited down to nothing keep what the page has.
…7-S1, R7-S2)

- A same-version rewrite takes the version from apps/<slug>.md, not the tag:
  v1.0 and 1.0.0 compare equal, and the build checks the former.
- Notes with a phrase npm run check refuses stop that app's new version, or
  leave an edit untaken with a warning, instead of failing every candidate.
- releases/README says a hand edit needs its source: line and that refused
  edits are only in the run log (R7-S3, R7-N1).
Notes edited down to nothing, or to a phrase the site refuses, were one
::warning:: line an hour in a green run. planApp now says so (notes.held), and
the sync raises an Issue per app through the listing Issue path, closing it
once the page shows the release's notes again.
@itsdoubleem
itsdoubleem merged commit c450287 into main Nov 9, 2026
1 check passed
@itsdoubleem
itsdoubleem deleted the feat/notes-follow-release branch November 9, 2026 06:41

This branch was previously deployed

1 inactive deployment
github-pages — c4502879 Deployed Nov 9, 2026 by itsdoubleem via deploy #308
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant