Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

CHANGELOG.md with pre-release versions #588

Closed
1 task done
lictw opened this issue Apr 3, 2024 · 2 comments
Closed
1 task done

CHANGELOG.md with pre-release versions #588

lictw opened this issue Apr 3, 2024 · 2 comments
Assignees
Labels
feature/request New feature or request

Comments

@lictw
Copy link

lictw commented Apr 3, 2024

Is there an existing issue or pull request for this?

  • I have searched the existing issues and pull requests

Feature description

I have pre-release rc.* tags and would like to generate CHANGELOG.md with them. Now, without any options pre-release tags considered like everything else, so I will have notes for rc.*, but when I release new version git-cliff will generate notes only from latest RC tag, not from latest stable tag.

For clarify, for tags 2.0, 2.1-rc.0, 2.1-rc.1, and 2.1 I want:
2.0 -> 2.1-rc.0
2.1-rc.0 -> 2.1-rc.1
2.0 -> 2.1

Also I don't understand use-cases of skip_tags option, can you explain? For ex. if it alpha, does it drop all commits from any matched prev. tag to obtained alpha tag, for what can I need this?)

Desired solution

Separated logic for stable and pre-release tags.

Alternatives considered

Only manual approach with combinations of tag-pattern (include/exclude pre-release tags) (or ignore_tags, but it's 2 mostly repeatable configs, no CLI option) and --prepend option one by one from version to version, I can't find any way to generate all file with my requirements.

Additional context

No response

@lictw lictw added the feature/request New feature or request label Apr 3, 2024
Copy link

welcome bot commented Apr 3, 2024

Thanks for opening your first issue at git-cliff! Be sure to follow the issue template! ⛰️

@orhun
Copy link
Owner

orhun commented Apr 7, 2024

Hello!

Also I don't understand use-cases of skip_tags option, can you explain? For ex. if it alpha, does it drop all commits from any matched prev. tag to obtained alpha tag, for what can I need this?)

For example:

# regex for skipping tags
skip_tags = "beta|alpha"

# regex for ignoring tags
ignore_tags = "rc"

Consider this release history:

v0 -> v1-alpha -> v1-beta -> v1-rc.0 -> v1

  • Commits for beta and alpha releases won't appear in the changelog.
  • Commits for rc will appear under the most recent tag (v1)

So ignore_tags will move all of the commits contributing to those tags into the next non-ignored tags. Thus it also affects commits that themselves are not tagged.

Whereas skip_tags completely drops the tagged commits from processing but doesn't affect any other commits.

Let me know if this works for your use case and if there is anything else that I can help you with! 🐻

Repository owner locked and limited conversation to collaborators Apr 7, 2024
@orhun orhun converted this issue into discussion #595 Apr 7, 2024

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
feature/request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants