-
-
Notifications
You must be signed in to change notification settings - Fork 166
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add tag message to release context
- add to the release context the tag's message if it exists - add message to the default config
- Loading branch information
Showing
13 changed files
with
257 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
[changelog] | ||
# template for the changelog footer | ||
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") }} | ||
{% if message %} | ||
{{ message }}\ | ||
{% endif %}\ | ||
{% else %}\ | ||
## [unreleased] | ||
{% endif %}\ | ||
{% for group, commits in commits | group_by(attribute="group") %} | ||
### {{ group | upper_first }} | ||
{% for commit in commits %} | ||
- {{ 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 parsing and grouping commits | ||
commit_parsers = [ | ||
{ message = "^feat", group = "Features", default_scope = "app" }, | ||
{ message = "^fix", group = "Bug Fixes", scope = "cli" }, | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
#!/usr/bin/env bash | ||
set -e | ||
|
||
GIT_COMMITTER_DATE="2022-04-06 01:25:08" git commit --allow-empty -m "Initial commit" | ||
GIT_COMMITTER_DATE="2022-04-06 01:25:09" git commit --allow-empty -m "feat: add feature 1" | ||
GIT_COMMITTER_DATE="2022-04-06 01:25:10" git commit --allow-empty -m "fix: fix feature 1" | ||
git tag v0.1.0 -m "Some text" | ||
GIT_COMMITTER_DATE="2022-04-06 01:25:11" git commit --allow-empty -m "feat(gui): add feature 2" | ||
GIT_COMMITTER_DATE="2022-04-06 01:25:12" git commit --allow-empty -m "fix(gui): fix feature 2" | ||
git tag v0.2.0 | ||
GIT_COMMITTER_DATE="2022-04-06 01:25:13" git commit --allow-empty -m "test: add tests" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
## [unreleased] | ||
|
||
### Test | ||
|
||
- Add tests | ||
|
||
## [0.2.0] - 2022-04-06 | ||
|
||
### Bug Fixes | ||
|
||
- Fix feature 2 | ||
|
||
### Features | ||
|
||
- Add feature 2 | ||
|
||
## [0.1.0] - 2022-04-06 | ||
|
||
Some text | ||
|
||
### Bug Fixes | ||
|
||
- Fix feature 1 | ||
|
||
### Features | ||
|
||
- Add feature 1 | ||
|
||
<!-- generated by git-cliff --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
/// Common tag object that is parsed from a repository. | ||
/// lightweight tag will have None at message. | ||
#[derive(Debug)] | ||
pub struct Tag { | ||
/// The name of the tag | ||
pub name: String, | ||
/// the message of the tag. only if it was annotated | ||
pub message: Option<String>, | ||
} | ||
|
||
#[cfg(test)] | ||
mod test { | ||
use super::*; | ||
|
||
#[test] | ||
fn create_tag_with_name_and_message() { | ||
let tag = Tag { | ||
name: String::from("v1.0"), | ||
message: Some(String::from("Initial release")), | ||
}; | ||
assert_eq!(tag.name, "v1.0"); | ||
assert_eq!(tag.message, Some(String::from("Initial release"))); | ||
} | ||
|
||
#[test] | ||
fn create_tag_with_name_and_no_message() { | ||
let tag = Tag { | ||
name: String::from("v1.0"), | ||
message: None, | ||
}; | ||
assert_eq!(tag.name, "v1.0"); | ||
assert_eq!(tag.message, None); | ||
} | ||
|
||
#[test] | ||
fn debug_print_tag_with_message() { | ||
let tag = Tag { | ||
name: String::from("v1.0"), | ||
message: Some(String::from("Initial release")), | ||
}; | ||
assert_eq!( | ||
format!("{:?}", tag), | ||
"Tag { name: \"v1.0\", message: Some(\"Initial release\") }" | ||
); | ||
} | ||
} |
Oops, something went wrong.