-
Notifications
You must be signed in to change notification settings - Fork 338
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[ GitHub ] Add release.yml
to format automatically generated release notes
#7254
base: master
Are you sure you want to change the base?
Conversation
release.yml
to control automatically generated release notesrelease.yml
to format automatically generated release notes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great stuff!
- travis | ||
- typo | ||
- Makefile | ||
- release |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this list be the same as the CIFM one:
agda/src/release-tools/closed-issues-for-milestone/Main.hs
Lines 115 to 146 in 1c449e2
labelsNotInChangelog :: Set Label | |
labelsNotInChangelog = Set.fromList | |
[ "Makefile" | |
, "agda-bisect" | |
, "bug-tracker" | |
, "closed-issues-for-milestone" | |
, "devx" | |
, "debug" | |
, "documented-in-changelog" | |
, "faq" | |
, "fix-agda-whitespace" | |
, "haddock" | |
, "hTags" | |
, "infra: github workflows" | |
, "infra: test suite" | |
, "maculata" | |
, "not-in-changelog" | |
, "refactor" | |
, "regression on master" | |
, "release" | |
, "repository" | |
, "status: abandoned" | |
, "status: duplicate" | |
, "status: invalid" | |
, "status: wontfix" | |
, "status: working-as-intended" | |
, "style" | |
, "travis" | |
, "type: question" | |
, "type: task" | |
, "typo" | |
] |
If yes, maybe the latter should be read from the new YAML file to avoid duplication.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right -- I will revise it.
I just realised that the automatically generated release notes can be configured according to this.
At present, the release note for the latest commit is automatically generated, but it could be more informative. It includes all PRs, even those with labels like
not-in-changelog
that are clearly not very interesting. So, I am adding therelease.yml
to exclude those PRs labellednot-in-changelog
,type
, and so on.We may take advantage of organising PRs into sections based on their labels, such as a section for bug fixes and another for
type: enhancement
. On the other hand, perhaps I shouldn't over-engineer the format of automatically generated notes, so I shall add thisrelease.yml
as it is and refine the configuration gradually.