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

RFC: Split the CHANGELOG #1964

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

ni-jfitzger
Copy link
Collaborator

@ni-jfitzger ni-jfitzger commented May 12, 2023

TODO: Check the above box with an 'x' indicating you've read and followed CONTRIBUTING.md.

TODO: Check the above box with an 'x' if considered if there were any and then documented client facing changes in CHANGELOG.md. Strike through if this is not a relevant client facing change.

  • I've added tests applicable for this pull request

TODO: Check the above box with an 'x' indicating you have considered and added any applicable system or unit tests. Strike through if you considered and decided additional tests were not warranted.

What does this Pull Request accomplish?

Copies the CHANGELOG Into individual src/ folders and removes sections that are not relevant to the module.

I am not trying to:

  • Eliminate sections where the module was not released (after the initial release)
  • Remove ALL of Module headings for previous releases.
    • This would mean merging notes for the sections and some may not be relevant to the particular module.

TODO: Update the PR template to have checkboxes for each individual CHANGELOG?
TODO: Update github_actions files to ignore each individual CHANGELOG
TODO: Finish cleaning up each module's CHANGELOG and delete the old CHANGELOG
TODO: Update build_release.py CHANGELOG.md instructions

List issues fixed by this Pull Request below, if any.

TODO: List of issues.

  • Fix #xxx
  • Fix #yyy

What testing has been done?

TODO: Detail what testing has been done to ensure this submission meets requirements.

@ni-jfitzger ni-jfitzger changed the title RFC: Split-the-CHANGELOG RFC: Split the CHANGELOG May 12, 2023
@ni-jfitzger ni-jfitzger linked an issue May 12, 2023 that may be closed by this pull request
@ni-jfitzger
Copy link
Collaborator Author

ni-jfitzger commented May 12, 2023

Alternatives to consider:

  1. Stick with the Unified CHANGELOG and leave version out of the overall section heading (grouping releases by date) moving forward, but include release version in heading for individual driver sections
  2. Keep the Unified CHANGELOG for previous releases, but point it at individual CHANGELOGs for new releases and point individual CHANGELOGs at the unified CHANGELOG for old releases. Do not copy previous release notes into individual CHANGELOGs.
  3. Use individual CHANGELOGs but don't try to remove irrelevant information for previous releases. The original CHANGELOG will be deleted.

@marcoskirsch
Copy link
Member

What happens with CHANGELOG.md in the root directory?

@ni-jfitzger
Copy link
Collaborator Author

What happens with CHANGELOG.md in the root directory?

If we don't choose one of the alternatives, I'll delete it as part of this change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update CHANGELOG system for independent package versioning
2 participants