Skip to content

What is the expected behavior of "between-tags"? #450

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.

Sign up for GitHub

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

Jump to bottom
Closed
tduffield opened this issue Nov 10, 2016 · 7 comments
Closed

What is the expected behavior of "between-tags"? #450

tduffield opened this issue Nov 10, 2016 · 7 comments
Labels
question

Comments

@tduffield
Copy link
Contributor

The wording of the description of "between-tags" says that the "Change log will be filled only between specified tags". What I took that to mean was that if I specified tags, the section headers would combine the changelog for those tags.

For example, say I have the following tags: 1.2.[0-20], 1.3.[0-40], and 1.4.[0-10].
Now, lets say that I specify the following config:

since-tag=1.2.0
between-tags=1.2.12,1.2.34,1.3.15,1.4.10

I would expect the following:

# 1.4.10
compare/1.3.16...1.4.10

# 1.3.15
compare/1.2.35...1.3.15

# 1.2.34
compare/1.2.13...1.2.34

# 1.2.12
compare/1.2.0...1.2.12

But instead, I get the following:

# 1.4.10
compare/1.4.9...1.4.10

# 1.3.15
compare/1.3.14...1.3.15

# 1.2.34
compare/1.2.33...1.2.34

# 1.2.12
compare/1.2.11...1.2.12

Which of these two is the expected behavior?
@tduffield
Copy link
Contributor Author

Sorry @olleolleolle, but it'd be great if I can have an answer in the next couple days. I have some time-sensitive work that depends on the answer.

@olleolleolle
Copy link
Collaborator

I have not investigated --between-tags. Not sure what it wants to do. The actual behavior seems not-so-useful, though.

@skywinder, do you know?

@tduffield If you feel like poking through the history and deduce, it's all there.

@tduffield
Copy link
Contributor Author

@olleolleolle I did look through the history briefly but I didn't see anything that answered my question super clearly.

@tduffield tduffield mentioned this issue Nov 20, 2016
Closed
@skywinder
Copy link
Member

The --between-tags not pretty useful and quite outdated option.
It works like filter for tags. i.e. leave tags, that specified after this option.
I think we can remove it in next major release to simplify the code.

@tduffield
Copy link
Contributor Author

I have to disagree. The between-tags is super useful for us (given my PR) in that we bump the version after every PR automatically but want the change log to reflect stable "releases." Im down if we want to deprecate that but having a way to specify section groupings is a must for us.

@Lucashuang0802 Lucashuang0802 mentioned this issue May 22, 2017
Merged
@Lucashuang0802
Copy link
Contributor

The --between-tags will be removed on the next release, @olleolleolle so this is not an issue anymore? 😃

@espears4sq
Copy link

How can we achieve the functionality of --between-tags now that #501 removed it? The functionality it provided is still required by users, in fact needing feature enhancements even. How best to achieve it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
question
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@olleolleolle @tduffield @skywinder @Lucashuang0802 @espears4sq