mirror of
https://github.com/orhun/git-cliff.git
synced 2024-08-16 18:30:30 +03:00
feat(context): add repository path to template context
This commit is contained in:
parent
94891c2c27
commit
e5b31a26e5
@ -613,7 +613,7 @@ mod test {
|
||||
header: Some(String::from("# Changelog")),
|
||||
body: Some(String::from(
|
||||
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 %}
|
||||
## Unreleased{% endif %}
|
||||
{% for group, commits in commits | group_by(attribute="group") %}
|
||||
@ -880,6 +880,7 @@ mod test {
|
||||
commit_id: Some(String::from("0bc123")),
|
||||
timestamp: 50000000,
|
||||
previous: None,
|
||||
repository: Some(String::from("/root/repo")),
|
||||
#[cfg(feature = "github")]
|
||||
github: crate::remote::RemoteReleaseMetadata {
|
||||
contributors: vec![],
|
||||
@ -939,6 +940,7 @@ mod test {
|
||||
commit_id: None,
|
||||
timestamp: 1000,
|
||||
previous: Some(Box::new(test_release)),
|
||||
repository: Some(String::from("/root/repo")),
|
||||
#[cfg(feature = "github")]
|
||||
github: crate::remote::RemoteReleaseMetadata {
|
||||
contributors: vec![],
|
||||
@ -972,7 +974,7 @@ mod test {
|
||||
String::from(
|
||||
r#"# Changelog
|
||||
|
||||
## Release [v1.1.0] - 1970-01-01
|
||||
## Release [v1.1.0] - 1970-01-01 - (/root/repo)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
@ -990,7 +992,7 @@ mod test {
|
||||
#### ui
|
||||
- do exciting stuff
|
||||
|
||||
## Release [v1.0.0] - 1971-08-02
|
||||
## Release [v1.0.0] - 1971-08-02 - (/root/repo)
|
||||
(0bc123)
|
||||
|
||||
### Bug Fixes
|
||||
@ -1115,7 +1117,7 @@ chore(deps): fix broken deps
|
||||
#### app
|
||||
- merge #5
|
||||
|
||||
## Release [v1.0.0] - 1971-08-02
|
||||
## Release [v1.0.0] - 1971-08-02 - (/root/repo)
|
||||
(0bc123)
|
||||
|
||||
### Bug Fixes
|
||||
|
@ -20,28 +20,30 @@ use serde::{
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct Release<'a> {
|
||||
/// Release version, git tag.
|
||||
pub version: Option<String>,
|
||||
pub version: Option<String>,
|
||||
/// Commits made for the release.
|
||||
pub commits: Vec<Commit<'a>>,
|
||||
pub commits: Vec<Commit<'a>>,
|
||||
/// Commit ID of the tag.
|
||||
#[serde(rename = "commit_id")]
|
||||
pub commit_id: Option<String>,
|
||||
pub commit_id: Option<String>,
|
||||
/// Timestamp of the release in seconds, from epoch.
|
||||
pub timestamp: i64,
|
||||
pub timestamp: i64,
|
||||
/// Previous release.
|
||||
pub previous: Option<Box<Release<'a>>>,
|
||||
pub previous: Option<Box<Release<'a>>>,
|
||||
/// Repository path.
|
||||
pub repository: Option<String>,
|
||||
/// Contributors.
|
||||
#[cfg(feature = "github")]
|
||||
pub github: RemoteReleaseMetadata,
|
||||
pub github: RemoteReleaseMetadata,
|
||||
/// Contributors.
|
||||
#[cfg(feature = "gitlab")]
|
||||
pub gitlab: RemoteReleaseMetadata,
|
||||
pub gitlab: RemoteReleaseMetadata,
|
||||
/// Contributors.
|
||||
#[cfg(feature = "gitea")]
|
||||
pub gitea: RemoteReleaseMetadata,
|
||||
pub gitea: RemoteReleaseMetadata,
|
||||
/// Contributors.
|
||||
#[cfg(feature = "bitbucket")]
|
||||
pub bitbucket: RemoteReleaseMetadata,
|
||||
pub bitbucket: RemoteReleaseMetadata,
|
||||
}
|
||||
|
||||
#[cfg(feature = "github")]
|
||||
@ -169,6 +171,7 @@ mod test {
|
||||
version: Some(String::from(version)),
|
||||
..Default::default()
|
||||
})),
|
||||
repository: Some(String::from("/root/repo")),
|
||||
#[cfg(feature = "github")]
|
||||
github: crate::remote::RemoteReleaseMetadata {
|
||||
contributors: vec![],
|
||||
@ -368,6 +371,7 @@ mod test {
|
||||
version: Some(String::from("1.0.0")),
|
||||
..Default::default()
|
||||
})),
|
||||
repository: Some(String::from("/root/repo")),
|
||||
github: RemoteReleaseMetadata {
|
||||
contributors: vec![],
|
||||
},
|
||||
@ -653,6 +657,7 @@ mod test {
|
||||
version: Some(String::from("1.0.0")),
|
||||
..Default::default()
|
||||
})),
|
||||
repository: Some(String::from("/root/repo")),
|
||||
#[cfg(feature = "github")]
|
||||
github: RemoteReleaseMetadata {
|
||||
contributors: vec![],
|
||||
@ -996,6 +1001,7 @@ mod test {
|
||||
version: Some(String::from("1.0.0")),
|
||||
..Default::default()
|
||||
})),
|
||||
repository: Some(String::from("/root/repo")),
|
||||
#[cfg(feature = "github")]
|
||||
github: RemoteReleaseMetadata {
|
||||
contributors: vec![],
|
||||
|
@ -22,7 +22,9 @@ use url::Url;
|
||||
///
|
||||
/// [`Repository`]: GitRepository
|
||||
pub struct Repository {
|
||||
inner: GitRepository,
|
||||
inner: GitRepository,
|
||||
/// Repository path.
|
||||
pub path: PathBuf,
|
||||
}
|
||||
|
||||
impl Repository {
|
||||
@ -30,7 +32,8 @@ impl Repository {
|
||||
pub fn init(path: PathBuf) -> Result<Self> {
|
||||
if path.exists() {
|
||||
Ok(Self {
|
||||
inner: GitRepository::open(path)?,
|
||||
inner: GitRepository::open(&path)?,
|
||||
path,
|
||||
})
|
||||
} else {
|
||||
Err(Error::IoError(io::Error::new(
|
||||
|
@ -205,6 +205,7 @@ mod test {
|
||||
commit_id: None,
|
||||
timestamp: 0,
|
||||
previous: None,
|
||||
repository: Some(String::from("/root/repo")),
|
||||
#[cfg(feature = "github")]
|
||||
github: crate::remote::RemoteReleaseMetadata {
|
||||
contributors: vec![],
|
||||
|
@ -193,6 +193,7 @@ fn generate_changelog() -> Result<()> {
|
||||
commit_id: None,
|
||||
timestamp: 0,
|
||||
previous: None,
|
||||
repository: Some(String::from("/root/repo")),
|
||||
#[cfg(feature = "github")]
|
||||
github: git_cliff_core::remote::RemoteReleaseMetadata {
|
||||
contributors: vec![],
|
||||
@ -233,6 +234,7 @@ fn generate_changelog() -> Result<()> {
|
||||
commit_id: None,
|
||||
timestamp: 0,
|
||||
previous: None,
|
||||
repository: Some(String::from("/root/repo")),
|
||||
#[cfg(feature = "github")]
|
||||
github: git_cliff_core::remote::RemoteReleaseMetadata {
|
||||
contributors: vec![],
|
||||
|
@ -243,6 +243,8 @@ fn process_repository<'a>(
|
||||
for git_commit in commits.iter().rev() {
|
||||
let commit = Commit::from(git_commit);
|
||||
let commit_id = commit.id.to_string();
|
||||
releases[release_index].repository =
|
||||
Some(repository.path.to_string_lossy().to_string());
|
||||
if args.sort == Sort::Newest {
|
||||
releases[release_index].commits.insert(0, commit);
|
||||
} else {
|
||||
|
@ -61,6 +61,7 @@ following context is generated to use for templating:
|
||||
],
|
||||
"commit_id": "a440c6eb26404be4877b7e3ad592bfaa5d4eb210 (release commit)",
|
||||
"timestamp": 1625169301,
|
||||
"repository": "/path/to/repository",
|
||||
"previous": {
|
||||
"version": "previous release"
|
||||
}
|
||||
@ -154,6 +155,7 @@ If [`conventional_commits`](/docs/configuration/git#conventional_commits) is set
|
||||
],
|
||||
"commit_id": "a440c6eb26404be4877b7e3ad592bfaa5d4eb210 (release commit)",
|
||||
"timestamp": 1625169301,
|
||||
"repository": "/path/to/repository",
|
||||
"previous": {
|
||||
"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.
|
||||
|
||||
:::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