Skip to content

docs(release): CHANGELOG.md for the docs and the plugin, a GitHub release per tag with its notes - #90

Merged
Teg79 merged 2 commits into
mainfrom
docs/changelog
Nov 18, 2026
Merged

Teg79 merged 2 commits into
mainfrom
docs/changelog

Conversation

@Teg79

@Teg79 Teg79 commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • CHANGELOG.md (new), Keep a Changelog, for the docs and the Claude Code plugin:
    • each plugin version as ### Plugin X with the minimum urbex it needs;
    • the 0.1.0 entry, retroactive: plugin 0.2.0 (urbex 0.1.0 or later, major 0) and the docs that install from the release;
    • an Unreleased section and the rule.
  • scripts/release-notes.sh (new): the same extractor as urbex-cli's tools/release/notes.sh; fails without an entry.
  • .github/workflows/release.yml (new; urbex had no workflow), on v* tags (the changelog's relative links rewritten to the tag's files):
    • a GitHub release titled "urbex X - docs and plugin P";
    • its notes: the version's notes and a link to urbex-cli's release of the same tag; the run fails without them;
    • a pre-release while 0.x or with a suffix;
    • checkout pinned by SHA, contents: write for the job only, runs only in urbforge/urbex.
  • tests/plugin-scripts.sh: fails when the plugin's version in plugin.json has no ### Plugin X section. It keeps the Python checks' exit status, which the new lines would otherwise have hidden.
  • README.md, docs/upgrading.md: where the notes are.

The urbex v0.1.0 GitHub release is published, on Teg's OK: https://github.com/urbforge/urbex/releases/tag/v0.1.0. It was created from the existing tag (no new tag), as a pre-release titled "urbex 0.1.0 - docs and plugin 0.2.0", with this branch's 0.1.0 notes. The changelog's relative links (docs/...) were made absolute at the tag, since they don't resolve on a release page. The workflow now does the same for every tag.

Plugin 0.2.1 (#89): once this is merged, #89 adds its ### Plugin 0.2.1 under Unreleased. tests/plugin-scripts.sh will require it.

Why

urbforge/redemptor#54: urbex's v0.1.0 was a tag only, and the plugin's versions had no notes saying what changed or which CLI they need.

Tests I ran

  • scripts/release-notes.sh v0.1.0: the 0.1.0 notes.
  • tests/plugin-scripts.sh: passes (ok CHANGELOG.md has plugin 0.2.0). With plugin.json set to 9.9.9 it fails, naming the missing section.
  • The workflow parses as YAML; the plugin version read from plugin.json: 0.2.0.
  • Not run: the workflow on a tag.

Checklist before review

  • Linked issue, Conventional Commit title
  • Relative links resolve
  • No secrets, tokens or private addresses

Part of urbforge/redemptor#54, with urbforge/urbex-cli#118 and urbforge/redemptor#55.

🤖 Generated with Claude Code

https://claude.ai/code/session_0182yxsfwRowwnxCfgrQwjnA

…ease per tag with its notes

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0182yxsfwRowwnxCfgrQwjnA
…he release page

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0182yxsfwRowwnxCfgrQwjnA
@Teg79
Teg79 marked this pull request as ready for review November 17, 2026 19:49
@Teg79
Teg79 merged commit 3cd298b into main Nov 18, 2026
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.

2 participants