Skip to content
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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

L-TChen
Copy link
Member

@L-TChen L-TChen commented May 14, 2024

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 the release.yml to exclude those PRs labelled not-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 this release.yml as it is and refine the configuration gradually.

@L-TChen L-TChen added the infra: github workflows Issues related to GitHub workflows and actions (not in changelog) label May 14, 2024
@L-TChen L-TChen changed the title [ GitHub ] Add release.yml to control automatically generated release notes [ GitHub ] Add release.yml to format automatically generated release notes May 14, 2024
Copy link
Member

@andreasabel andreasabel left a 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
Copy link
Member

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:

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.

Copy link
Member Author

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.

@andreasabel andreasabel added the closed-issues-for-milestone Issues related to the closed-issues-for-milestone program (not in changelog) label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closed-issues-for-milestone Issues related to the closed-issues-for-milestone program (not in changelog) infra: github workflows Issues related to GitHub workflows and actions (not in changelog)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants