search

alexellis / derek

Reduce maintainer fatigue by automating GitHub
https://github.com/alexellis/derek/blob/master/USER_GUIDE.md
MIT License
806 stars 72 forks source link

Exclude pre-releases from release notes #184

Open jLopezbarb opened 2 years ago

jLopezbarb commented 2 years ago

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 commented 2 years ago

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 :slightly_smiling_face:

Alex

alexellis commented 2 years ago

/add label: enhancement,question,support

alexellis commented 2 years ago

/set title: Exclude pre-releases from release notes

rgee0 commented 2 years ago

@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?