Repository navigation
Cap a changelog fragment at one sentence, and re-cut v1.0.0 to fit - #258
Merged
Merged
Conversation
changie now refuses a body over 280 characters, which is about where a second sentence ends. The rule and its reasoning are on the release page and in the pull request guidelines. Every v1.0.0 note was rewritten to one sentence, two at most. The longest three ran 424, 493, and 320 characters; the detail they carried already lives on the pages they describe. changes/v1.0.0.md and the CHANGELOG section are byte-identical, and the published release notes were updated from the same file.
github-actions
Bot
added
the
documentation
3 of 10 tasks
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
1 participant
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
A changelog fragment is now one sentence, two at most, enforced by changie rather than by review. Every v1.0.0 note was rewritten to that length, and the published release notes were updated from the same file.
Type of Change
Changes
.changie.yamlcaps a body at 280 characters and floors it at 10, sochangie newrefuses an over-long fragment at the prompt instead of leaving it for a reviewer to catch.content/docs/release.mdstates the rule where the fragment workflow is documented: one sentence, two if the second earns it, and hitting the cap means the fragment is carrying documentation that belongs on a page the notes can link to.CONTRIBUTING.mdadds the same rule to the pull request guidelines, since that is what a first-time contributor reads.CHANGELOG.mdandchanges/v1.0.0.mdre-cut all 18 v1.0.0 notes. The longest three ran 424, 493, and 320 characters; every note is now under the cap, and the two files are byte-identical.No changelog fragment for this change: it alters how fragments are written and rewords notes for a release already published, so nothing an upgrading user can observe changes. Say the word if you would rather it carried a
Miscentry.Testing
make allpassesAlso verified by hand:
changie newrejects a 281-character body and accepts a short one, against this repository's config.diff <(head -25 CHANGELOG.md) changes/v1.0.0.mdis empty.gh release edit v1.0.0 --notes-file changes/v1.0.0.mdand now matches that file.Related Issues
None