docs: Add step to update CHANGELOG.md in RELEASE.md#8856
docs: Add step to update CHANGELOG.md in RELEASE.md#8856steviez merged 1 commit intoanza-xyz:masterfrom
Conversation
willhickey
left a comment
willhickey
left a comment
There was a problem hiding this comment.
We current have instructions in both RELEASE.md and CHANGELOG.md that are required for creating a new branch. I'm planning to reorganize them (probably by moving everything into RELEASE.md), but this change is an improvement so let's merge it.
Don't think I was aware of this block in We don't have to push this PR; we can the reorganization instead. I can try to take a stab at that today while I'm waiting for CI or something |
steviez
force-pushed
the
doc_release_changelog
branch
from
3310aad to
3d55f9e
Compare
steviez
force-pushed
the
doc_release_changelog
branch
from
3d55f9e to
83778ab
Compare
Took a look and went with this option; think it is too easy to miss the steps buried at the bottom of
The commits can't be 1-to-1 for master and beta so this seemed like the right path to avoid pushing anything related to a future branch (ie v4.0) to a current branch (v3.1) |
steviez
force-pushed
the
doc_release_changelog
branch
from
83778ab to
bbd08ec
Compare
steviez
left a comment
steviez
left a comment
There was a problem hiding this comment.
updated; force push was just to rebase to tip but I left the review comments in separate commit for ease of review. Will squash pre-merge
RELEASE.md already has a list of steps to perform when creating a new branch. Updating CHANGELOG.md is one of those steps to perform, so move the tasks over to make it harder to miss
steviez
force-pushed
the
doc_release_changelog
branch
from
bbd08ec to
3b87210
Compare
docs: Consolidate changelog update steps into RELEASE.md RELEASE.md already has a list of steps to perform when creating a new branch. Updating CHANGELOG.md is one of those steps to perform, so move the tasks over to make it harder to miss
docs: Consolidate changelog update steps into RELEASE.md RELEASE.md already has a list of steps to perform when creating a new branch. Updating CHANGELOG.md is one of those steps to perform, so move the tasks over to make it harder to miss
3 participants
Problem
This is a recurring step that should happen for every release.
Summary of Changes
Document the step so there is less chance of it being forgotten.
In the future, potentially aspire to an automated GH action and/or CI enforcement (ie #8829 (review))