Repository navigation
docs(contributing): the PR title is the whole commit; fixing a release entry (#289) - #322
Merged
Merged
Conversation
…e entry (#289) - The squash commit on main is the PR title only, so the description is never parsed: write it freely, code included. - How to repair a missed or wrong changelog entry: a BEGIN_COMMIT_OVERRIDE block in the merged PR's description, then re-run the Release workflow. Used for #318, whose description a code line made unparseable.
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.
Follow-up to the release setup (#289 / #316).
What happened: #318's squash commit carried its whole PR description. One line of it, a wrapped C++ signature starting
DrumDisplay(, made release-please's Conventional Commits parser fail (unexpected token), so it silently dropped thefeat(firmware)and no release PR appeared. It was fixed with aBEGIN_COMMIT_OVERRIDEblock on #318 plus a manual Release run, which produced #321 (release firmware 0.2.0).Prevention:
docs/contributing/conventions.md:mainfor both firmware and hardware, and that descriptions can hold any code;Verification:
check_doc_refs.pypasses; whitespace clean.