Skip to content

docs: publish releases via gh release edit, drop stale develop references - #462

Open
Wiesenwischer wants to merge 1 commit into
mainfrom
feature/release-publish-via-gh-cli
Open

Wiesenwischer wants to merge 1 commit into
mainfrom
feature/release-publish-via-gh-cli

Conversation

@Wiesenwischer

Copy link
Copy Markdown
Owner

Why

Follow-up to the v0.82.0 release: the release list briefly held two entries with the same tag — the real release plus the Release-Drafter draft that gh release create had left behind. Tag-based gh release edit/delete are ambiguous in that state, so cleanup needed the numeric release id.

Changes

  • Step 3 "Publish Release": publish the existing draft, with the CLI recipe (gh api ... select(.draft==true)gh release edit <tag> --notes-file … --draft=false --latest) next to the GitHub-UI path, plus a note that the drafter's raw "What's Changed" list is not sufficient as release notes.
  • Step 4 "Verify": check that no draft was left behind.
  • Stale develop references removedmain is the only permanent branch (CLAUDE.md), so PRs come from feature/*/bugfix/*, and the hotfix step no longer mentions bypassing develop.
  • Dev image section corrected: docker-dev.yml triggers on push to main (tags ignored) and tags the image latest — the doc claimed a develop trigger and a :develop tag, including in the docker inspect example.

Docs only — no code, no workflow changes.

…nces

Document that a release is published by promoting the existing Release-Drafter
draft (GitHub UI or 'gh release edit --draft=false') and why 'gh release create'
must not be used: the drafter keeps its draft, leaving two same-tag entries that
make tag-based edit/delete ambiguous.

Also correct claims that no longer hold: there is no 'develop' branch (main is
the only permanent one), and the dev image is built on push to 'main' and tagged
'latest', not 'develop' (see .github/workflows/docker-dev.yml).
@github-actions github-actions Bot added documentation Improvements or additions to documentation feature New feature or enhancement labels Jul 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation feature New feature or enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant