@@ -64,16 +64,16 @@ normally used exclusively in pre-releases.
64
64
65
65
Example: ` git.tagExclude: *[-]* `
66
66
67
- Note that ` git.tagExclude ` has no effect when ` git.getLatestTagFromAllRefs: true ` . See the next section
68
- [ use all refs to determine latest tag] ( #use-all-refs-to-determine-latest-tag ) for more details.
67
+ Note that ` git.tagExclude ` has no effect when ` git.getLatestTagFromAllRefs: true ` . See the next section [ use all refs to
68
+ determine latest tag] [ 7 ] for more details.
69
69
70
70
## Use all refs to determine latest tag
71
71
72
- By default, Git determines the latest tag using [ ` git describe ` ] ( https://git-scm.com/docs/git-describe ) , which finds the
73
- most recent tag _ that is reachable from a commit._ If you wish to consider all tags, e.g. to include tags that point to
74
- sibling commits on different branches, then set ` git.getLatestTagFromAllRefs: true ` (the default is ` false ` ).
72
+ By default, Git determines the latest tag using [ ` git describe ` ] [ 8 ] , which finds the most recent tag _ that is reachable
73
+ from a commit._ If you wish to consider all tags, e.g. to include tags that point to sibling commits on different
74
+ branches, then set ` git.getLatestTagFromAllRefs: true ` (the default is ` false ` ).
75
75
76
- ![ Determine latest tag from all refs] ( assets/git-version-from-all-refs.svg )
76
+ ![ Determine latest tag from all refs] [ 9 ]
77
77
78
78
In the above illustration, releasing from ` develop ` and incrementing the semver ` rc ` modifier, when
79
79
` git.getLatestTagFromAllRefs: false ` (the default), the latest tag is ` v1.1.0-rc1 ` , because that is the most recent tag
@@ -90,7 +90,7 @@ In case extra arguments should be provided to Git, these options are available:
90
90
- ` git.tagArgs `
91
91
- ` git.pushArgs `
92
92
93
- For example, use ` "git.commitArgs": ["-S"] ` to sign commits (also see [ #35 ] [ 7 ] ).
93
+ For example, use ` "git.commitArgs": ["-S"] ` to sign commits (also see [ #35 ] [ 10 ] ).
94
94
95
95
Note that ` ["--follow-tags"] ` is the default for ` pushArgs ` (re-add this manually if necessary). Example with multiple
96
96
arguments for ` git push ` :
@@ -171,7 +171,7 @@ example use case and how it can be handled using release-it:
171
171
By default, release-it does not check the number of commits upfront to prevent "empty" releases. Configure
172
172
` "git.requireCommits": true ` to exit the release-it process if there are no commits since the latest tag.
173
173
174
- Also see the [ Require Commits] [ 8 ] recipe(s).
174
+ Also see the [ Require Commits] [ 11 ] recipe(s).
175
175
176
176
## Further customizations
177
177
@@ -197,5 +197,8 @@ script.
197
197
[ 4 ] : https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories
198
198
[ 5 ] : https://support.atlassian.com/bitbucket-cloud/docs/configure-ssh-and-two-step-verification/
199
199
[ 6 ] : https://gitlab.com/help/ssh/README.md
200
- [ 7 ] : https://github.com/release-it/release-it/issues/350
201
- [ 8 ] : ./recipes/require-commits.md
200
+ [ 7 ] : #use-all-refs-to-determine-latest-tag
201
+ [ 8 ] : https://git-scm.com/docs/git-describe
202
+ [ 9 ] : assets/git-version-from-all-refs.svg
203
+ [ 10 ] : https://github.com/release-it/release-it/issues/350
204
+ [ 11 ] : ./recipes/require-commits.md
0 commit comments