Extract breaking
information from PR body
#52
Labels
No Label
breaking
bug
build
duplicate
enhancement
feature
help wanted
invalid
lgtm/done
lgtm/need 1
question
skip-changelog
wontfix
No Milestone
No project
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: lunny/changelog#52
Loading…
Reference in New Issue
Block a user
No description provided.
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
A major purpose of changelogs is to find out about breaking changes, which should be stated as specific as possible. Currently PR title is used, which is rarely helpful.
Given 2 PRs
#101: add more CLI flags
į: fix CVE
with comment bodies containing something likethe following CHANGELOG could be generated:
The tag used to extract the section could also be an HTML comment
ref gitea/tea#346
Currently, we only match with labels, so content keyword search should be another method.
imo you should label such PRs
kind/breaking
(or however you like)I'm not really a fan of magic comments unless they can be heavily justified.
That being said, perhaps an enhancement where the YAML file can include a bool
snippet
(or something else, if snippet isn't appropriate) that would grab the first line(s?) of the description and put it in a sub-list, e.g.And an example
changelog.yml
block