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

Remove pre-releases from release_notes #186

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

Conversation

rgee0
Copy link
Contributor

@rgee0 rgee0 commented Apr 18, 2022

Currently in draft as need to consider the effect in generation of release notes for a pre-release. As proposed, this would be cumulative over a number of pre-releases as prerelease is only consider when finding the previous release, so each pre-release will be considered against the previous full release.

Signed-off-by: Richard Gee [email protected]

Description

Initially the release notes were being generated from the current tagged
release (n) and the n-1 release, irrespective of whether n-1 was a full
release. This change causes getWorkingReleases() to ignore any previous
releases where PreRelease is set to true. The processing beyond this
determination will continue to consider all commits between the two identified
points, resulting in a fuller set of changes for a full release where
Pre-Releases have occurred in between.

Motivation and Context

  • I have raised an issue to propose this change (required)

Closes #184

How Has This Been Tested?

TBC

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Feature Enhancement

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Initially the release notes were being generated from the current tagged
release (n) and the n-1 release, irrespective of whether n-1 was a full
release.  This change causes `getWorkingReleases()` to ignore any previous
releases where `PreRelease` is set to `true`.  The processing beyond this
determination will continue to consider all commits between the two identified
points, resulting in a fuller set of changes for a full release where
Pre-Releases have occured in between.

Signed-off-by: Richard Gee <[email protected]>
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.

Exclude pre-releases from release notes
1 participant