mirror of
https://github.com/orhun/git-cliff.git
synced 2024-09-11 15:05:30 +03:00
feat(context): add repository path to template context (#721)
This commit is contained in:
parent
3eb828e69a
commit
e7807e13c4
@ -613,7 +613,7 @@ mod test {
|
|||||||
header: Some(String::from("# Changelog")),
|
header: Some(String::from("# Changelog")),
|
||||||
body: Some(String::from(
|
body: Some(String::from(
|
||||||
r#"{% if version %}
|
r#"{% if version %}
|
||||||
## Release [{{ version }}] - {{ timestamp | date(format="%Y-%m-%d") }}
|
## Release [{{ version }}] - {{ timestamp | date(format="%Y-%m-%d") }} - ({{ repository }})
|
||||||
{% if commit_id %}({{ commit_id }}){% endif %}{% else %}
|
{% if commit_id %}({{ commit_id }}){% endif %}{% else %}
|
||||||
## Unreleased{% endif %}
|
## Unreleased{% endif %}
|
||||||
{% for group, commits in commits | group_by(attribute="group") %}
|
{% for group, commits in commits | group_by(attribute="group") %}
|
||||||
@ -881,6 +881,7 @@ mod test {
|
|||||||
commit_id: Some(String::from("0bc123")),
|
commit_id: Some(String::from("0bc123")),
|
||||||
timestamp: 50000000,
|
timestamp: 50000000,
|
||||||
previous: None,
|
previous: None,
|
||||||
|
repository: Some(String::from("/root/repo")),
|
||||||
#[cfg(feature = "github")]
|
#[cfg(feature = "github")]
|
||||||
github: crate::remote::RemoteReleaseMetadata {
|
github: crate::remote::RemoteReleaseMetadata {
|
||||||
contributors: vec![],
|
contributors: vec![],
|
||||||
@ -941,6 +942,7 @@ mod test {
|
|||||||
commit_id: None,
|
commit_id: None,
|
||||||
timestamp: 1000,
|
timestamp: 1000,
|
||||||
previous: Some(Box::new(test_release)),
|
previous: Some(Box::new(test_release)),
|
||||||
|
repository: Some(String::from("/root/repo")),
|
||||||
#[cfg(feature = "github")]
|
#[cfg(feature = "github")]
|
||||||
github: crate::remote::RemoteReleaseMetadata {
|
github: crate::remote::RemoteReleaseMetadata {
|
||||||
contributors: vec![],
|
contributors: vec![],
|
||||||
@ -974,7 +976,7 @@ mod test {
|
|||||||
String::from(
|
String::from(
|
||||||
r#"# Changelog
|
r#"# Changelog
|
||||||
|
|
||||||
## Release [v1.1.0] - 1970-01-01
|
## Release [v1.1.0] - 1970-01-01 - (/root/repo)
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
@ -992,7 +994,7 @@ mod test {
|
|||||||
#### ui
|
#### ui
|
||||||
- do exciting stuff
|
- do exciting stuff
|
||||||
|
|
||||||
## Release [v1.0.0] - 1971-08-02
|
## Release [v1.0.0] - 1971-08-02 - (/root/repo)
|
||||||
(0bc123)
|
(0bc123)
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
@ -1117,7 +1119,7 @@ chore(deps): fix broken deps
|
|||||||
#### app
|
#### app
|
||||||
- merge #5
|
- merge #5
|
||||||
|
|
||||||
## Release [v1.0.0] - 1971-08-02
|
## Release [v1.0.0] - 1971-08-02 - (/root/repo)
|
||||||
(0bc123)
|
(0bc123)
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
@ -20,30 +20,32 @@ use serde::{
|
|||||||
#[serde(rename_all = "camelCase")]
|
#[serde(rename_all = "camelCase")]
|
||||||
pub struct Release<'a> {
|
pub struct Release<'a> {
|
||||||
/// Release version, git tag.
|
/// Release version, git tag.
|
||||||
pub version: Option<String>,
|
pub version: Option<String>,
|
||||||
/// git tag's message.
|
/// git tag's message.
|
||||||
pub message: Option<String>,
|
pub message: Option<String>,
|
||||||
/// Commits made for the release.
|
/// Commits made for the release.
|
||||||
pub commits: Vec<Commit<'a>>,
|
pub commits: Vec<Commit<'a>>,
|
||||||
/// Commit ID of the tag.
|
/// Commit ID of the tag.
|
||||||
#[serde(rename = "commit_id")]
|
#[serde(rename = "commit_id")]
|
||||||
pub commit_id: Option<String>,
|
pub commit_id: Option<String>,
|
||||||
/// Timestamp of the release in seconds, from epoch.
|
/// Timestamp of the release in seconds, from epoch.
|
||||||
pub timestamp: i64,
|
pub timestamp: i64,
|
||||||
/// Previous release.
|
/// Previous release.
|
||||||
pub previous: Option<Box<Release<'a>>>,
|
pub previous: Option<Box<Release<'a>>>,
|
||||||
|
/// Repository path.
|
||||||
|
pub repository: Option<String>,
|
||||||
/// Contributors.
|
/// Contributors.
|
||||||
#[cfg(feature = "github")]
|
#[cfg(feature = "github")]
|
||||||
pub github: RemoteReleaseMetadata,
|
pub github: RemoteReleaseMetadata,
|
||||||
/// Contributors.
|
/// Contributors.
|
||||||
#[cfg(feature = "gitlab")]
|
#[cfg(feature = "gitlab")]
|
||||||
pub gitlab: RemoteReleaseMetadata,
|
pub gitlab: RemoteReleaseMetadata,
|
||||||
/// Contributors.
|
/// Contributors.
|
||||||
#[cfg(feature = "gitea")]
|
#[cfg(feature = "gitea")]
|
||||||
pub gitea: RemoteReleaseMetadata,
|
pub gitea: RemoteReleaseMetadata,
|
||||||
/// Contributors.
|
/// Contributors.
|
||||||
#[cfg(feature = "bitbucket")]
|
#[cfg(feature = "bitbucket")]
|
||||||
pub bitbucket: RemoteReleaseMetadata,
|
pub bitbucket: RemoteReleaseMetadata,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "github")]
|
#[cfg(feature = "github")]
|
||||||
@ -187,6 +189,7 @@ mod test {
|
|||||||
version: Some(String::from(version)),
|
version: Some(String::from(version)),
|
||||||
..Default::default()
|
..Default::default()
|
||||||
})),
|
})),
|
||||||
|
repository: Some(String::from("/root/repo")),
|
||||||
#[cfg(feature = "github")]
|
#[cfg(feature = "github")]
|
||||||
github: crate::remote::RemoteReleaseMetadata {
|
github: crate::remote::RemoteReleaseMetadata {
|
||||||
contributors: vec![],
|
contributors: vec![],
|
||||||
@ -395,6 +398,7 @@ mod test {
|
|||||||
version: Some(String::from("1.0.0")),
|
version: Some(String::from("1.0.0")),
|
||||||
..Default::default()
|
..Default::default()
|
||||||
})),
|
})),
|
||||||
|
repository: Some(String::from("/root/repo")),
|
||||||
github: RemoteReleaseMetadata {
|
github: RemoteReleaseMetadata {
|
||||||
contributors: vec![],
|
contributors: vec![],
|
||||||
},
|
},
|
||||||
@ -681,6 +685,7 @@ mod test {
|
|||||||
version: Some(String::from("1.0.0")),
|
version: Some(String::from("1.0.0")),
|
||||||
..Default::default()
|
..Default::default()
|
||||||
})),
|
})),
|
||||||
|
repository: Some(String::from("/root/repo")),
|
||||||
#[cfg(feature = "github")]
|
#[cfg(feature = "github")]
|
||||||
github: RemoteReleaseMetadata {
|
github: RemoteReleaseMetadata {
|
||||||
contributors: vec![],
|
contributors: vec![],
|
||||||
@ -1025,6 +1030,7 @@ mod test {
|
|||||||
version: Some(String::from("1.0.0")),
|
version: Some(String::from("1.0.0")),
|
||||||
..Default::default()
|
..Default::default()
|
||||||
})),
|
})),
|
||||||
|
repository: Some(String::from("/root/repo")),
|
||||||
#[cfg(feature = "github")]
|
#[cfg(feature = "github")]
|
||||||
github: RemoteReleaseMetadata {
|
github: RemoteReleaseMetadata {
|
||||||
contributors: vec![],
|
contributors: vec![],
|
||||||
|
@ -32,7 +32,9 @@ static TAG_SIGNATURE_REGEX: Lazy<Regex> = lazy_regex!(
|
|||||||
///
|
///
|
||||||
/// [`Repository`]: GitRepository
|
/// [`Repository`]: GitRepository
|
||||||
pub struct Repository {
|
pub struct Repository {
|
||||||
inner: GitRepository,
|
inner: GitRepository,
|
||||||
|
/// Repository path.
|
||||||
|
pub path: PathBuf,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Repository {
|
impl Repository {
|
||||||
@ -40,7 +42,8 @@ impl Repository {
|
|||||||
pub fn init(path: PathBuf) -> Result<Self> {
|
pub fn init(path: PathBuf) -> Result<Self> {
|
||||||
if path.exists() {
|
if path.exists() {
|
||||||
Ok(Self {
|
Ok(Self {
|
||||||
inner: GitRepository::open(path)?,
|
inner: GitRepository::open(&path)?,
|
||||||
|
path,
|
||||||
})
|
})
|
||||||
} else {
|
} else {
|
||||||
Err(Error::IoError(io::Error::new(
|
Err(Error::IoError(io::Error::new(
|
||||||
|
@ -206,6 +206,7 @@ mod test {
|
|||||||
commit_id: None,
|
commit_id: None,
|
||||||
timestamp: 0,
|
timestamp: 0,
|
||||||
previous: None,
|
previous: None,
|
||||||
|
repository: Some(String::from("/root/repo")),
|
||||||
#[cfg(feature = "github")]
|
#[cfg(feature = "github")]
|
||||||
github: crate::remote::RemoteReleaseMetadata {
|
github: crate::remote::RemoteReleaseMetadata {
|
||||||
contributors: vec![],
|
contributors: vec![],
|
||||||
|
@ -194,6 +194,7 @@ fn generate_changelog() -> Result<()> {
|
|||||||
commit_id: None,
|
commit_id: None,
|
||||||
timestamp: 0,
|
timestamp: 0,
|
||||||
previous: None,
|
previous: None,
|
||||||
|
repository: Some(String::from("/root/repo")),
|
||||||
#[cfg(feature = "github")]
|
#[cfg(feature = "github")]
|
||||||
github: git_cliff_core::remote::RemoteReleaseMetadata {
|
github: git_cliff_core::remote::RemoteReleaseMetadata {
|
||||||
contributors: vec![],
|
contributors: vec![],
|
||||||
@ -235,6 +236,7 @@ fn generate_changelog() -> Result<()> {
|
|||||||
commit_id: None,
|
commit_id: None,
|
||||||
timestamp: 0,
|
timestamp: 0,
|
||||||
previous: None,
|
previous: None,
|
||||||
|
repository: Some(String::from("/root/repo")),
|
||||||
#[cfg(feature = "github")]
|
#[cfg(feature = "github")]
|
||||||
github: git_cliff_core::remote::RemoteReleaseMetadata {
|
github: git_cliff_core::remote::RemoteReleaseMetadata {
|
||||||
contributors: vec![],
|
contributors: vec![],
|
||||||
|
@ -245,6 +245,8 @@ fn process_repository<'a>(
|
|||||||
for git_commit in commits.iter().rev() {
|
for git_commit in commits.iter().rev() {
|
||||||
let commit = Commit::from(git_commit);
|
let commit = Commit::from(git_commit);
|
||||||
let commit_id = commit.id.to_string();
|
let commit_id = commit.id.to_string();
|
||||||
|
releases[release_index].repository =
|
||||||
|
Some(repository.path.to_string_lossy().to_string());
|
||||||
if args.sort == Sort::Newest {
|
if args.sort == Sort::Newest {
|
||||||
releases[release_index].commits.insert(0, commit);
|
releases[release_index].commits.insert(0, commit);
|
||||||
} else {
|
} else {
|
||||||
|
@ -62,6 +62,7 @@ following context is generated to use for templating:
|
|||||||
],
|
],
|
||||||
"commit_id": "a440c6eb26404be4877b7e3ad592bfaa5d4eb210 (release commit)",
|
"commit_id": "a440c6eb26404be4877b7e3ad592bfaa5d4eb210 (release commit)",
|
||||||
"timestamp": 1625169301,
|
"timestamp": 1625169301,
|
||||||
|
"repository": "/path/to/repository",
|
||||||
"previous": {
|
"previous": {
|
||||||
"version": "previous release"
|
"version": "previous release"
|
||||||
}
|
}
|
||||||
@ -156,6 +157,7 @@ If [`conventional_commits`](/docs/configuration/git#conventional_commits) is set
|
|||||||
],
|
],
|
||||||
"commit_id": "a440c6eb26404be4877b7e3ad592bfaa5d4eb210 (release commit)",
|
"commit_id": "a440c6eb26404be4877b7e3ad592bfaa5d4eb210 (release commit)",
|
||||||
"timestamp": 1625169301,
|
"timestamp": 1625169301,
|
||||||
|
"repository": "/path/to/repository",
|
||||||
"previous": {
|
"previous": {
|
||||||
"version": "previous release"
|
"version": "previous release"
|
||||||
}
|
}
|
||||||
|
@ -11,3 +11,11 @@ git cliff --repository path1 path2
|
|||||||
```
|
```
|
||||||
|
|
||||||
Note that the changelog will be generated using the merged history of the given repositories.
|
Note that the changelog will be generated using the merged history of the given repositories.
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
|
||||||
|
You can use the `{{ repository }}` variable in the template to display which release belongs to which repository.
|
||||||
|
|
||||||
|
See [context](/docs/templating/context) for more information.
|
||||||
|
|
||||||
|
:::
|
||||||
|
Loading…
Reference in New Issue
Block a user