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

Improve changelog processing to prevent conflicts #6041

Open
2 of 5 tasks
randmonkey opened this issue May 16, 2024 · 0 comments
Open
2 of 5 tasks

Improve changelog processing to prevent conflicts #6041

randmonkey opened this issue May 16, 2024 · 0 comments
Labels
area/ci area/maintenance Cleanup, refactoring, and other maintenance improvements that don't change functionality.
Milestone

Comments

@randmonkey
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Does this enhancement require public documentation?

  • I have added an Acceptance Criteria item for adding and/or adjusting public documentation (if applicable)

Problem Statement

Currently we edit changelog by directly editing the CHANGELOG.md file. This method has several inconveniences:

  • Very easy to fall into conflicts. When 2 PRs are both editing the changelog, It is likely to conflict on the CHANGELOG.md file. It rarely succeed to create a backport PR automatically when the PR has changelog updates because of conflicts.
  • Need to manually add items and diff links in each release. The two parts are on the top and bottom of the whole changelog separately. It is possible to forget one of them.

Proposed Solution

  • Develop a tool to extract changelog from PR description or title
  • Let the tool to generate the changelogs for each release

Additional information

No response

Acceptance Criteria

  • PR template includes the "Changelog" section to set the wanted changelog item related to this PR
  • A tool automatically fetches the changelogs from the PR and generates the summarized changelog for each release
  • Include guide in CONTRIBUTING.md to help contributors to set changlog in PRs
@randmonkey randmonkey added area/ci area/maintenance Cleanup, refactoring, and other maintenance improvements that don't change functionality. labels May 16, 2024
@randmonkey randmonkey added this to the KIC 3.3.x milestone May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ci area/maintenance Cleanup, refactoring, and other maintenance improvements that don't change functionality.
Projects
None yet
Development

No branches or pull requests

1 participant