Skip to content

Commit ebe4fbd

Browse files
committed
Format Markdown
1 parent c1c0f99 commit ebe4fbd

File tree

2 files changed

+16
-13
lines changed

2 files changed

+16
-13
lines changed

docs/git.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,16 @@ normally used exclusively in pre-releases.
6464

6565
Example: `git.tagExclude: *[-]*`
6666

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.
6969

7070
## Use all refs to determine latest tag
7171

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`).
7575

76-
![Determine latest tag from all refs](assets/git-version-from-all-refs.svg)
76+
![Determine latest tag from all refs][9]
7777

7878
In the above illustration, releasing from `develop` and incrementing the semver `rc` modifier, when
7979
`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:
9090
- `git.tagArgs`
9191
- `git.pushArgs`
9292

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]).
9494

9595
Note that `["--follow-tags"]` is the default for `pushArgs` (re-add this manually if necessary). Example with multiple
9696
arguments for `git push`:
@@ -171,7 +171,7 @@ example use case and how it can be handled using release-it:
171171
By default, release-it does not check the number of commits upfront to prevent "empty" releases. Configure
172172
`"git.requireCommits": true` to exit the release-it process if there are no commits since the latest tag.
173173

174-
Also see the [Require Commits][8] recipe(s).
174+
Also see the [Require Commits][11] recipe(s).
175175

176176
## Further customizations
177177

@@ -197,5 +197,8 @@ script.
197197
[4]: https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories
198198
[5]: https://support.atlassian.com/bitbucket-cloud/docs/configure-ssh-and-two-step-verification/
199199
[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

docs/npm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ The default registry is [https://registry.npmjs.org][2]. The publish to another
8585

8686
## Config public path of registry
8787

88-
The default public path is `/package`. To customize an alternative path, update or set the
89-
`publishConfig`. For example, if a third-party tool such as `Verdaccio` is used to build a private server to proxy
90-
npm registry, then the URL address of the web user interface is `http://{{host}}-/web/detail/{{packageName}}`:
88+
The default public path is `/package`. To customize an alternative path, update or set the `publishConfig`. For example,
89+
if a third-party tool such as `Verdaccio` is used to build a private server to proxy npm registry, then the URL address
90+
of the web user interface is `http://{{host}}-/web/detail/{{packageName}}`:
9191

9292
```json
9393
{

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy