Standard-version: Complete changelog between full releases instead of pre-release...release

Created on 17 Feb 2020  路  3Comments  路  Source: conventional-changelog/standard-version

Hey,

npm run release currently produces a changelog output for the last tag and the current tag. This is exactly what I expect from release-a...release-b and pre-release-a...pre-release-b but it also does pre-release-a...full-release-b

How about adding an option that always updates the CHANGELOG with all changes between full releases instead of changes between a pre-release and a full release?

Example of the current behavior

# Starting from 1.0.0
# add a feature
npm run release -- --pre-release alpha # 1.1.0-alpha.0
# fix a bug
npm run release -- --pre-release alpha # 1.1.0-alpha.1
npm run release # 1.1.0 

This generates a CHANGELOG with a diff of 1.1.0-alpha.1...1.1.0
What I would expect from the new option is a diff between 1.0.0...1.1.0

Why?
As a producer of changes I'm aware that only a couple of changes happened between a pre-release and a full-release

As a consumer of changes I might only stick to the stable releases and ignore pre-releases. I also want to know what to expect when I update from 1.0.0 to 1.1.0 without reading through all pre-release notes

Most helpful comment

Hi folks!

I'm also interested in this feature, but I noticed this can be currently worked around.
e.g. I released 0.5.1, 1.0.0-rc.1 ~ 1.0.0-rc.2, 1.0.0 versions.

Generated changelog for 1.0.0 is between 1.0.0-rc.2 and 1.0.0.

Then if I delete local git tags for all rc versions and the latest tag. for example

git tag -d 1.0.0-rc.1
git tag -d 1.0.0-rc.2
git tag -d 1.0.0

Then when I regenerate CHANGELOG.md, it is between 0.5.1 and 1.0.0.

All 3 comments

not a bad idea... ;-) hence my thumb up.
Though it would not comply with the conventional-changelog standard, afaik.

I'm also interested in this feature, it would be a useful one to have.

Hi folks!

I'm also interested in this feature, but I noticed this can be currently worked around.
e.g. I released 0.5.1, 1.0.0-rc.1 ~ 1.0.0-rc.2, 1.0.0 versions.

Generated changelog for 1.0.0 is between 1.0.0-rc.2 and 1.0.0.

Then if I delete local git tags for all rc versions and the latest tag. for example

git tag -d 1.0.0-rc.1
git tag -d 1.0.0-rc.2
git tag -d 1.0.0

Then when I regenerate CHANGELOG.md, it is between 0.5.1 and 1.0.0.

Was this page helpful?
0 / 5 - 0 ratings