mirror of
https://github.com/orhun/git-cliff.git
synced 2024-09-11 15:05:30 +03:00
Compare commits
3 Commits
4c91b11854
...
abea58681d
Author | SHA1 | Date | |
---|---|---|---|
|
abea58681d | ||
|
b8045e97ed | ||
|
f41568f64e |
34
.github/fixtures/test-invert-ignore-tags/cliff.toml
vendored
Normal file
34
.github/fixtures/test-invert-ignore-tags/cliff.toml
vendored
Normal file
@ -0,0 +1,34 @@
|
||||
[changelog]
|
||||
# changelog header
|
||||
header = """
|
||||
# Changelog\n
|
||||
All notable changes to this project will be documented in this file.\n
|
||||
"""
|
||||
# template for the changelog body
|
||||
# https://keats.github.io/tera/docs/#introduction
|
||||
body = """
|
||||
{% if version %}\
|
||||
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
|
||||
{% else %}\
|
||||
## [unreleased]
|
||||
{% endif %}\
|
||||
{% for group, commits in commits | group_by(attribute="group") %}
|
||||
### {{ group | upper_first }}
|
||||
{% for commit in commits %}
|
||||
- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
|
||||
{% endfor %}
|
||||
{% endfor %}\n
|
||||
"""
|
||||
# template for the changelog footer
|
||||
footer = """
|
||||
<!-- generated by git-cliff -->
|
||||
"""
|
||||
# remove the leading and trailing whitespace from the templates
|
||||
trim = true
|
||||
|
||||
[git]
|
||||
# regex for skipping tags
|
||||
skip_tags = "v0.1.0-beta.1"
|
||||
# regex for ignoring tags
|
||||
ignore_tags = "v.*-beta.*"
|
||||
count_tags = "v0.2.0"
|
15
.github/fixtures/test-invert-ignore-tags/commit.sh
vendored
Executable file
15
.github/fixtures/test-invert-ignore-tags/commit.sh
vendored
Executable file
@ -0,0 +1,15 @@
|
||||
#!/usr/bin/env bash
|
||||
set -e
|
||||
|
||||
GIT_COMMITTER_DATE="2021-01-23 01:23:45" git commit --allow-empty -m "feat: add skip feature"
|
||||
git tag v0.1.0-beta.1
|
||||
|
||||
GIT_COMMITTER_DATE="2021-01-23 01:23:46" git commit --allow-empty -m "feat: add feature 1"
|
||||
GIT_COMMITTER_DATE="2021-01-23 01:23:47" git commit --allow-empty -m "feat: fix feature 1"
|
||||
git tag v0.1.0
|
||||
|
||||
GIT_COMMITTER_DATE="2021-01-23 01:23:48" git commit --allow-empty -m "feat: add feature 2"
|
||||
git tag v0.2.0-beta.1
|
||||
|
||||
GIT_COMMITTER_DATE="2021-01-23 01:23:49" git commit --allow-empty -m "feat: add feature 3"
|
||||
git tag v0.2.0
|
14
.github/fixtures/test-invert-ignore-tags/expected.md
vendored
Normal file
14
.github/fixtures/test-invert-ignore-tags/expected.md
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## [0.2.0] - 2021-01-23
|
||||
|
||||
### Feat
|
||||
|
||||
- Add feature 1
|
||||
- Fix feature 1
|
||||
- Add feature 2
|
||||
- Add feature 3
|
||||
|
||||
<!-- generated by git-cliff -->
|
1
.github/workflows/test-fixtures.yml
vendored
1
.github/workflows/test-fixtures.yml
vendored
@ -22,6 +22,7 @@ jobs:
|
||||
- fixtures-name: test-gitea-integration
|
||||
- fixtures-name: test-bitbucket-integration
|
||||
- fixtures-name: test-ignore-tags
|
||||
- fixtures-name: test-invert-ignore-tags
|
||||
- fixtures-name: test-topo-order
|
||||
command: --latest
|
||||
- fixtures-name: test-date-order
|
||||
|
4
Cargo.lock
generated
4
Cargo.lock
generated
@ -1530,9 +1530,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "log"
|
||||
version = "0.4.21"
|
||||
version = "0.4.22"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "90ed8c1e510134f979dbc4f070f87d4313098b704861a105fe34231c70a3901c"
|
||||
checksum = "a7a70ba024b9dc04c27ea2f0c0548feb474ec5c54bba33a7f72f873a39d07b24"
|
||||
|
||||
[[package]]
|
||||
name = "memchr"
|
||||
|
@ -5,7 +5,7 @@ members = ["git-cliff-core", "git-cliff"]
|
||||
[workspace.dependencies]
|
||||
regex = "1.10.5"
|
||||
glob = "0.3.1"
|
||||
log = "0.4.21"
|
||||
log = "0.4.22"
|
||||
secrecy = { version = "0.8.0", features = ["serde"] }
|
||||
lazy_static = "1.5.0"
|
||||
dirs = "5.0.1"
|
||||
|
@ -784,6 +784,7 @@ mod test {
|
||||
tag_pattern: None,
|
||||
skip_tags: Regex::new("v3.*").ok(),
|
||||
ignore_tags: None,
|
||||
count_tags: None,
|
||||
topo_order: Some(false),
|
||||
sort_commits: Some(String::from("oldest")),
|
||||
link_parsers: None,
|
||||
|
@ -109,6 +109,9 @@ pub struct GitConfig {
|
||||
/// Regex to ignore matched tags.
|
||||
#[serde(with = "serde_regex", default)]
|
||||
pub ignore_tags: Option<Regex>,
|
||||
/// Regex to count matched tags.
|
||||
#[serde(with = "serde_regex", default)]
|
||||
pub count_tags: Option<Regex>,
|
||||
/// Whether to sort tags topologically.
|
||||
pub topo_order: Option<bool>,
|
||||
/// Sorting of the commits inside sections.
|
||||
|
@ -118,6 +118,7 @@ fn generate_changelog() -> Result<()> {
|
||||
tag_pattern: None,
|
||||
skip_tags: None,
|
||||
ignore_tags: None,
|
||||
count_tags: None,
|
||||
topo_order: None,
|
||||
sort_commits: None,
|
||||
link_parsers: Some(vec![
|
||||
|
@ -154,6 +154,9 @@ pub struct Opt {
|
||||
/// Sets the tags to ignore in the changelog.
|
||||
#[arg(long, env = "GIT_CLIFF_IGNORE_TAGS", value_name = "PATTERN")]
|
||||
pub ignore_tags: Option<Regex>,
|
||||
/// Sets the tags to count in the changelog.
|
||||
#[arg(long, env = "GIT_CLIFF_COUNT_TAGS", value_name = "PATTERN")]
|
||||
pub count_tags: Option<Regex>,
|
||||
/// Sets commits that will be skipped in the changelog.
|
||||
#[arg(
|
||||
long,
|
||||
|
@ -86,6 +86,7 @@ fn process_repository<'a>(
|
||||
let mut tags = repository.tags(&config.git.tag_pattern, args.topo_order)?;
|
||||
let skip_regex = config.git.skip_tags.as_ref();
|
||||
let ignore_regex = config.git.ignore_tags.as_ref();
|
||||
let count_tags = config.git.count_tags.as_ref();
|
||||
tags.retain(|_, tag| {
|
||||
let name = &tag.name;
|
||||
|
||||
@ -95,6 +96,14 @@ fn process_repository<'a>(
|
||||
return true;
|
||||
}
|
||||
|
||||
let count = count_tags.map_or(true, |r| {
|
||||
let count_tag = r.is_match(name);
|
||||
if count_tag {
|
||||
trace!("Counting release: {}", name)
|
||||
}
|
||||
count_tag
|
||||
});
|
||||
|
||||
let ignore = ignore_regex.is_some_and(|r| {
|
||||
if r.as_str().trim().is_empty() {
|
||||
return false;
|
||||
@ -106,7 +115,8 @@ fn process_repository<'a>(
|
||||
}
|
||||
ignore_tag
|
||||
});
|
||||
!ignore
|
||||
|
||||
count && !ignore
|
||||
});
|
||||
|
||||
if !config.remote.github.is_set() {
|
||||
@ -508,6 +518,9 @@ pub fn run(mut args: Opt) -> Result<()> {
|
||||
if args.ignore_tags.is_some() {
|
||||
config.git.ignore_tags.clone_from(&args.ignore_tags);
|
||||
}
|
||||
if args.count_tags.is_some() {
|
||||
config.git.count_tags.clone_from(&args.count_tags);
|
||||
}
|
||||
// Process the repositories.
|
||||
let repositories = args.repository.clone().unwrap_or(vec![env::current_dir()?]);
|
||||
let mut releases = Vec::<Release>::new();
|
||||
|
@ -200,12 +200,28 @@ A regex for skip processing the matched tags.
|
||||
|
||||
A regex for ignore processing the matched tags.
|
||||
|
||||
This value can be also overridden with using the `--ignore-tags` argument.
|
||||
|
||||
While `skip_tags` drop commits from the changelog, `ignore_tags` include ignored commits into the next tag.
|
||||
|
||||
* Note that if a commit has multiple tags, any matched tag will result in all associated tags being ignored, including those not explicitly matched by the regex. This is because git-cliff processes tags at the commit level rather than individually.
|
||||
For more details, you can view the discussion [here](https://github.com/orhun/git-cliff/discussions/707)
|
||||
:::note
|
||||
|
||||
Note that if a commit has multiple tags, any matched tag will result in all associated tags being ignored, including those not explicitly matched by the regex. This is because git-cliff processes tags at the commit level rather than individually.
|
||||
For more details, you can view the discussion [here](https://github.com/orhun/git-cliff/discussions/707).
|
||||
|
||||
:::
|
||||
|
||||
This value can be also overridden with using the `--ignore-tags` argument.
|
||||
|
||||
### count_tags
|
||||
|
||||
A regex for _counting in_ the matched tags in the final result.
|
||||
|
||||
:::info
|
||||
|
||||
`count_tags` work like an inverted version of `ignore_tags`, that include all the commits but only count the specific tags.
|
||||
|
||||
:::
|
||||
|
||||
This value can be also overridden with using the `--count-tags` argument.
|
||||
|
||||
### topo_order
|
||||
|
||||
|
@ -37,6 +37,7 @@ git-cliff [FLAGS] [OPTIONS] [--] [RANGE]
|
||||
--with-commit <MSG>... Sets custom commit messages to include in the changelog [env: GIT_CLIFF_WITH_COMMIT=]
|
||||
--with-tag-message [<MSG>] Sets custom message for the latest release [env: GIT_CLIFF_WITH_TAG_MESSAGE=]
|
||||
--ignore-tags <PATTERN> Sets the tags to ignore in the changelog [env: GIT_CLIFF_IGNORE_TAGS=]
|
||||
--count-tags <PATTERN> Sets the tags to count in the changelog [env: GIT_CLIFF_COUNT_TAGS=]
|
||||
--skip-commit <SHA1>... Sets commits that will be skipped in the changelog [env: GIT_CLIFF_SKIP_COMMIT=]
|
||||
-p, --prepend <PATH> Prepends entries to the given changelog file [env: GIT_CLIFF_PREPEND=]
|
||||
-o, --output [<PATH>] Writes output to the given file [env: GIT_CLIFF_OUTPUT=]
|
||||
|
Loading…
Reference in New Issue
Block a user