nimi-python icon indicating copy to clipboard operation
nimi-python copied to clipboard

RFC: Split the CHANGELOG

Open ni-jfitzger opened this issue 1 year ago • 3 comments

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 avatar May 12 '23 14:05 ni-jfitzger

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.

ni-jfitzger avatar May 12 '23 14:05 ni-jfitzger

What happens with CHANGELOG.md in the root directory?

marcoskirsch avatar May 12 '23 15:05 marcoskirsch

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.

ni-jfitzger avatar May 12 '23 15:05 ni-jfitzger