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

chore(ci): add changelog automation #11503

Closed
wants to merge 2 commits into from
Closed

Conversation

vm-001
Copy link
Contributor

@vm-001 vm-001 commented Aug 31, 2023

Summary

Add changelog automation tool(implemented by GitHub workflow) to generate changelog file automatically based on the PR title.

PR title is not always qualified to be the changelog. For example, #11427 (feat(http-log): add allow list for logged headers), the user facing changelog should be more detailed by including the added fields.

message: "**HTTP-Log**: add `enable_logged_headers_allow_list` and `logged_headers_allow_list` fields in HTTP Log plugin."
type: feature
scope: Plugin
prs:
  - 11427

Therefore, I add a changelog form in PULL_REQUEST_TEMPLATE.md to allow contributors and reviewers to override it:

### Changelog

message:
type:
scope:
prs:
issues:

Once the changelog form is updated, people can easily re-generate changelog by leaving a comment( /update-changelog )

@vm-001 vm-001 marked this pull request as draft August 31, 2023 09:31
@vm-001 vm-001 added the pr/wip A work in progress PR opened to receive feedback label Aug 31, 2023
@github-actions github-actions bot added the chore Not part of the core functionality of kong, but still needed label Aug 31, 2023
@vm-001 vm-001 force-pushed the chore/changelog-automation branch 2 times, most recently from 99e6d65 to 252fd10 Compare September 5, 2023 09:41
@vm-001 vm-001 marked this pull request as ready for review September 5, 2023 09:42
@vm-001 vm-001 removed the pr/wip A work in progress PR opened to receive feedback label Sep 5, 2023
@vm-001 vm-001 closed this Sep 6, 2023
@vm-001
Copy link
Contributor Author

vm-001 commented Sep 6, 2023

#11514

@vm-001 vm-001 deleted the chore/changelog-automation branch September 7, 2023 03:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Not part of the core functionality of kong, but still needed core/docs size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant