mirror of
https://github.com/orhun/git-cliff.git
synced 2024-08-16 18:30:30 +03:00
Compare commits
4 Commits
6fb2295134
...
0105836108
Author | SHA1 | Date | |
---|---|---|---|
|
0105836108 | ||
|
b6d2a219c6 | ||
|
11533e8a16 | ||
|
e7807e13c4 |
@ -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") %}
|
||||
@ -881,6 +881,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![],
|
||||
@ -941,6 +942,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![],
|
||||
@ -974,7 +976,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
|
||||
@ -992,7 +994,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
|
||||
@ -1117,7 +1119,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,30 +20,32 @@ use serde::{
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct Release<'a> {
|
||||
/// Release version, git tag.
|
||||
pub version: Option<String>,
|
||||
pub version: Option<String>,
|
||||
/// git tag's message.
|
||||
pub message: Option<String>,
|
||||
pub message: 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")]
|
||||
@ -187,6 +189,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![],
|
||||
@ -395,6 +398,7 @@ mod test {
|
||||
version: Some(String::from("1.0.0")),
|
||||
..Default::default()
|
||||
})),
|
||||
repository: Some(String::from("/root/repo")),
|
||||
github: RemoteReleaseMetadata {
|
||||
contributors: vec![],
|
||||
},
|
||||
@ -681,6 +685,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![],
|
||||
@ -1025,6 +1030,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![],
|
||||
|
@ -32,7 +32,9 @@ static TAG_SIGNATURE_REGEX: Lazy<Regex> = lazy_regex!(
|
||||
///
|
||||
/// [`Repository`]: GitRepository
|
||||
pub struct Repository {
|
||||
inner: GitRepository,
|
||||
inner: GitRepository,
|
||||
/// Repository path.
|
||||
pub path: PathBuf,
|
||||
}
|
||||
|
||||
impl Repository {
|
||||
@ -40,7 +42,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(
|
||||
|
@ -206,6 +206,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![],
|
||||
|
@ -194,6 +194,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![],
|
||||
@ -235,6 +236,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![],
|
||||
|
@ -238,6 +238,7 @@ fn process_repository<'a>(
|
||||
let commit = Commit::from(git_commit);
|
||||
let commit_id = commit.id.to_string();
|
||||
release.commits.push(commit);
|
||||
release.repository = Some(repository.path.to_string_lossy().into_owned());
|
||||
if let Some(tag) = tags.get(&commit_id) {
|
||||
release.version = Some(tag.name.to_string());
|
||||
release.message = tag.message.clone();
|
||||
@ -568,8 +569,9 @@ pub fn run(mut args: Opt) -> Result<()> {
|
||||
}
|
||||
|
||||
if let Some(path) = &args.prepend {
|
||||
let changelog_before = fs::read_to_string(path)?;
|
||||
let mut out = io::BufWriter::new(File::create(path)?);
|
||||
changelog.prepend(fs::read_to_string(path)?, &mut out)?;
|
||||
changelog.prepend(changelog_before, &mut out)?;
|
||||
}
|
||||
if args.output.is_some() || args.prepend.is_none() {
|
||||
changelog.generate(&mut out)?;
|
||||
|
@ -62,6 +62,7 @@ following context is generated to use for templating:
|
||||
],
|
||||
"commit_id": "a440c6eb26404be4877b7e3ad592bfaa5d4eb210 (release commit)",
|
||||
"timestamp": 1625169301,
|
||||
"repository": "/path/to/repository",
|
||||
"previous": {
|
||||
"version": "previous release"
|
||||
}
|
||||
@ -156,6 +157,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