docs: record 0.1.0 in the changelog on main - #15
Open
RobertoIskandarani wants to merge 1 commit into
Open
Conversation
release.yml deletes the release branch, so the version heading only ever lives on the tag. The section here is a byte-for-byte copy of the tagged one. The runbook now spells out this step and the next-dev bump merge, which were both undocumented.
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.
Summary
Post-release bookkeeping for 0.1.0, and the two runbook steps that turned out to be missing while shipping it.
Changes
CHANGELOG.md: the## [0.1.0]heading only ever existed on the tag, becauserelease.ymldeletes the release branch after tagging. This records it on the default branch and opens a fresh empty## [Unreleased]above it. The## [0.1.0]section is a byte-for-byte copy of the tagged one — verified by diffing both against each other.RELEASE_SETUP.md§5: added steps 5 and 6. Step 5 is the changelog record above, with the rule that corrections after the fact go in the GitHub Release body rather than in the recorded section. Step 6 is the manual merge of the next-dev bump PR, which does not auto-merge becauseallow_auto_mergeis off on this repository. Step 4 also now mentions that thenugetenvironment requires amaintainersapproval before anything reaches nuget.org.Test Plan
Documentation only; no code, workflows or packaging touched.
## [0.1.0]section was diffed againstgit show v0.1.0:CHANGELOG.md— identical, 212 lines.## [Unreleased]is present again on the default branch, whichcut-release.ymlrequires for the next cut.Checklist
dotnet build/dotnet format/dotnet test— n/a, no source or project files touchedCHANGELOG.mdentry added — this PR is the changelog entry