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

Exclude pre-releases from release notes #184

Open
jLopezbarb opened this issue Jan 21, 2022 · 4 comments · May be fixed by #186
Open

Exclude pre-releases from release notes #184

jLopezbarb opened this issue Jan 21, 2022 · 4 comments · May be fixed by #186

Comments

@jLopezbarb
Copy link

Expected Behaviour

Derek should compare new releases against the latest official release rather than against the latest release which can be a pre-release.

Current Behaviour

When Derek generates the release notes he compares the last two releases regardless of whether they are pre-releases or not. This makes hard to read the changes from two official releases if there has been some release candidates.

Possible Solution

Compare new releases against the latest official release.

Steps to Reproduce (for bugs)

  1. Create an official release (1.0.0)
  2. Create a pre-release (1.1.0-rc.1)
  3. Create an official release (1.1.0)
  4. The generated notes will have no changes because its being compared against 1.1.0-rc.1 instead of 1.0.0

Context

I was trying to create a new release from a release candidate but now it's hard to read the release notes of the major release because if I want to read all the changes I have to go through all pre-releases to know what have change

@alexellis
Copy link
Owner

Hey @jLopezbarb

Happy for you to propose a pull request. Is there any reason you've not become a sponsor yet? We operate a hosted Derek version, which also goes towards our time spent on the project providing value to you directly 🙂

Alex

@alexellis
Copy link
Owner

/add label: enhancement,question,support

@alexellis
Copy link
Owner

/set title: Exclude pre-releases from release notes

@derek derek bot changed the title Generate notes should compare against official releases Exclude pre-releases from release notes Jan 25, 2022
@rgee0 rgee0 linked a pull request Apr 18, 2022 that will close this issue
12 tasks
@rgee0
Copy link
Contributor

rgee0 commented Apr 18, 2022

@jLopezbarb the community has pushed up a proposal (#186). It'd be great to get some independent testing performed on it - maybe thats something you can help with?

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

Successfully merging a pull request may close this issue.

3 participants