From d1ba52fbbe0df45547609d4e796526bac0380e7f Mon Sep 17 00:00:00 2001 From: Robson Cruz Date: Sun, 31 Oct 2021 21:30:55 -0300 Subject: [PATCH 1/4] git-changelog: add page --- pages/common/git-changelog.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 pages/common/git-changelog.md diff --git a/pages/common/git-changelog.md b/pages/common/git-changelog.md new file mode 100644 index 0000000000000..28bdf19eff1b5 --- /dev/null +++ b/pages/common/git-changelog.md @@ -0,0 +1,33 @@ +# git changelog + +> Generate a changelog report from repository commits and tags. +> Part of `git-extras`. +> More information: . + +- Updating existing file or creating a new History.md file with pretty formatted output: + +`git changelog` + +- Listing commits from the current version: + +`git changelog --list` + +- Listing a range of commits from 2.1.0 to now: + +`git changelog --list --start-tag 2.1.0` + +- Listing a pretty formatted range of commits between 0.5.0 and 1.0.0: + +`git changelog --start-tag 0.5.0 --final-tag 1.0.0` + +- Listing a pretty formatted range of commits between 0b97430 and 1.0.0: + +`git changelog --start-commit 0b97430 --final-tag 1.0.0` + +- Specifying a file for output: + +`git changelog CHANGELOG.md` + +- Replace contents of current changelog file entirely: + +`git changelog --prune-old` From efdc7d5085971e8041f408c8afdbcaccab6ae660 Mon Sep 17 00:00:00 2001 From: Robson Cruz Date: Sun, 31 Oct 2021 23:02:22 -0300 Subject: [PATCH 2/4] git-changelog: fix TLDR104 --- pages/common/git-changelog.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/pages/common/git-changelog.md b/pages/common/git-changelog.md index 28bdf19eff1b5..f430deffd98dd 100644 --- a/pages/common/git-changelog.md +++ b/pages/common/git-changelog.md @@ -4,27 +4,27 @@ > Part of `git-extras`. > More information: . -- Updating existing file or creating a new History.md file with pretty formatted output: +- Update existing file or creating a new History.md file with pretty formatted output: `git changelog` -- Listing commits from the current version: +- List commits from the current version: `git changelog --list` -- Listing a range of commits from 2.1.0 to now: +- List a range of commits from 2.1.0 to now: `git changelog --list --start-tag 2.1.0` -- Listing a pretty formatted range of commits between 0.5.0 and 1.0.0: +- List pretty formatted range of commits between 0.5.0 and 1.0.0: `git changelog --start-tag 0.5.0 --final-tag 1.0.0` -- Listing a pretty formatted range of commits between 0b97430 and 1.0.0: +- List pretty formatted range of commits between 0b97430 and 1.0.0: `git changelog --start-commit 0b97430 --final-tag 1.0.0` -- Specifying a file for output: +- Specify a file for output: `git changelog CHANGELOG.md` From e3a0842ff7702f0350f32bb8c9d29c6652b68a6c Mon Sep 17 00:00:00 2001 From: Robson Cruz Date: Mon, 1 Nov 2021 12:49:12 -0300 Subject: [PATCH 3/4] git-changelog: Apply code review suggestions Co-authored-by: Axel Navarro --- pages/common/git-changelog.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pages/common/git-changelog.md b/pages/common/git-changelog.md index f430deffd98dd..de71a7364ce0e 100644 --- a/pages/common/git-changelog.md +++ b/pages/common/git-changelog.md @@ -4,7 +4,7 @@ > Part of `git-extras`. > More information: . -- Update existing file or creating a new History.md file with pretty formatted output: +- Update existing file or create a new `History.md` file with the commit messages since the latest Git tag: `git changelog` @@ -12,19 +12,19 @@ `git changelog --list` -- List a range of commits from 2.1.0 to now: +- List a range of commits from the tag named `2.1.0` to now: `git changelog --list --start-tag 2.1.0` -- List pretty formatted range of commits between 0.5.0 and 1.0.0: +- List pretty formatted range of commits between the tag `0.5.0` and the tag `1.0.0`: `git changelog --start-tag 0.5.0 --final-tag 1.0.0` -- List pretty formatted range of commits between 0b97430 and 1.0.0: +- List pretty formatted range of commits between the commit `0b97430` and the tag `1.0.0`: `git changelog --start-commit 0b97430 --final-tag 1.0.0` -- Specify a file for output: +- Specify `CHANGELOG.md` as the output file: `git changelog CHANGELOG.md` From 405fd713fbd5192a1aeaecb5bb92eded6939df28 Mon Sep 17 00:00:00 2001 From: Robson Cruz Date: Thu, 4 Nov 2021 12:23:09 -0300 Subject: [PATCH 4/4] git-changelog: Apply code review suggestions Co-authored-by: Muhammad Falak R Wani --- pages/common/git-changelog.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pages/common/git-changelog.md b/pages/common/git-changelog.md index de71a7364ce0e..25a56ada99ece 100644 --- a/pages/common/git-changelog.md +++ b/pages/common/git-changelog.md @@ -14,19 +14,19 @@ - List a range of commits from the tag named `2.1.0` to now: -`git changelog --list --start-tag 2.1.0` +`git changelog --list --start-tag {{2.1.0}}` - List pretty formatted range of commits between the tag `0.5.0` and the tag `1.0.0`: -`git changelog --start-tag 0.5.0 --final-tag 1.0.0` +`git changelog --start-tag {{0.5.0}} --final-tag {{1.0.0}}` - List pretty formatted range of commits between the commit `0b97430` and the tag `1.0.0`: -`git changelog --start-commit 0b97430 --final-tag 1.0.0` +`git changelog --start-commit {{0b97430}} --final-tag {{1.0.0}}` - Specify `CHANGELOG.md` as the output file: -`git changelog CHANGELOG.md` +`git changelog {{CHANGELOG.md}}` - Replace contents of current changelog file entirely: