Skip to content

Commit 28213bf

Browse files
webprowebpro
committed
Move configuration options to existing doc pages + table format, shorten
1 parent 667cd6a commit 28213bf

10 files changed

+84
-87
lines changed

‎docs/configuration-git.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎docs/configuration-github.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎docs/configuration-gitlab.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎docs/configuration-hooks.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎docs/configuration-npm.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎docs/configuration.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,14 +80,12 @@ TOML is also supported in `.release-it.toml`:
8080

8181
## Configuration options
8282

83-
Release-it has [plenty of options][2] to configure. See the following tables
84-
for descriptions of each.
85-
86-
- [Hooks](./configuration-hooks.md)
87-
- [Git](./configuration-git.md)
88-
- [npm](./configuration-npm.md)
89-
- [GitHub](./configuration-github.md)
90-
- [GitLab](./configuration-gitlab.md)
83+
Release-it has [plenty of options][2]. See the following tables for plugin configuration options:
84+
85+
- [Git](./git.md#configuration-options)
86+
- [npm](./npm.md#configuration-options)
87+
- [GitHub](./github-releases.md#configuration-options)
88+
- [GitLab](./gitlab-releases.md#configuration-options)
9189

9290
## Setting options via CLI
9391

‎docs/git.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,32 @@ Configure the `[git.*]` options to modify the commands accordingly. See [all opt
1515

1616
The minimum required version of Git is v2.0.0.
1717

18+
## Configuration options
19+
20+
| Option | Description |
21+
| :---------------------------- | :----------------------------------------------------------------------- |
22+
| `git.changelog` | Changelog generation command |
23+
| `git.requireCleanWorkingDir` | Require that all file changes are committed |
24+
| `git.requireBranch` | Require that the release is on a particular branch name |
25+
| `git.requireUpstream` | Require that an upstream remote exists. |
26+
| `git.requireCommits` | Stop the process if there are no commits since the previous release |
27+
| `git.requireCommitsFail` | If there are no commits, continue but use exit code `0` |
28+
| `git.commitsPath` | The path to the directory that should be included in the release changes |
29+
| `git.addUntrackedFiles` | Add untracked files to the release commit |
30+
| `git.commit` | If `false`, skip the commit release step |
31+
| `git.commitMessage` | The message to add to the commit step |
32+
| `git.commitArgs` | Provide extra arguments to `git commit` |
33+
| `git.tag` | If `false`, skip the tag release step |
34+
| `git.tagExclude` | Override the normal behavior to find the latest tag |
35+
| `git.tagName` | Custom tag name, which may not be the same as the (prefixed) version |
36+
| `git.tagMatch` | Override the normal matching behavior to find the latest tag |
37+
| `git.getLatestTagFromAllRefs` | Consider all tags (directly reachable or not, sorted by version) |
38+
| `git.tagAnnotation` | Message string for annotating the Git tag |
39+
| `git.tagArgs` | Provide extra arguments to `git tag` |
40+
| `git.push` | If `false`, skip the push release step |
41+
| `git.pushArgs` | Provided extra arguments to `git push` |
42+
| `git.pushRepo` | Remote name or Git URL to push the release to (defaultL `origin`) |
43+
1844
## Git remotes
1945

2046
SSH keys and Git remotes are assumed to be configured correctly. If a manual `git push` from the command line works,

‎docs/github-releases.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,27 @@ To add [GitHub releases][3] in your release-it flow, there are two options:
1414
1. Automated. This requires a personal access token.
1515
2. Manual. The GitHub web interface will be opened with pre-populated fields.
1616

17+
## Configuration options
18+
19+
| Option | Description |
20+
| :----------------------- | :------------------------------------------------------------------------------ |
21+
| `github.release` | Set to `false` to skip the GitHub publish step |
22+
| `github.releaseName` | Set the release name (default: `Release ${version}`) |
23+
| `github.releaseNotes` | Override the release notes with custom notes |
24+
| `github.autoGenerate` | Let GitHub generate release notes |
25+
| `github.preRelease` | Set the release to a pre-release status |
26+
| `github.draft` | Set the release to a draft status |
27+
| `github.tokenRef` | GitHub token environment variable name (default: `GITHUB_TOKEN`) |
28+
| `github.assets` | Glob pattern path to assets to add to the GitHub release |
29+
| `github.host` | Use a different host from what would be derived from the Git URL |
30+
| `github.timeout` | Timeout duration to wait for a response from the GitHub API |
31+
| `github.proxy` | If the release is performed behind a proxy, set this to string of the proxy URL |
32+
| `github.skipChecks` | Skip checks on `GITHUB_TOKEN` environment variable and user permissions |
33+
| `github.web` | Explicitly override checking if the `GITHUB_TOKEN` is set |
34+
| `github.comments.submit` | Submit a comment to each merged PR and closed issue part of the release |
35+
| `github.comments.issue` | The text to add to the associated closed issues |
36+
| `github.comments.pr` | The text to add to the associated merged pull requests |
37+
1738
## Automated
1839

1940
To automate the release (using the GitHub REST API), the following needs to be configured:

‎docs/gitlab-releases.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,22 @@ part][2] is configured correctly.
1212

1313
GitLab Releases do not support pre-releases or drafts.
1414

15+
## Configuration options
16+
17+
| Option | Description |
18+
| :-------------------------------- | :------------------------------------------------------------------ |
19+
| `gitlab.release` | Set to `false` to skip the GitLab publish step |
20+
| `gitlab.releaseName` | Set the release name (default: `Release ${version}`) |
21+
| `gitlab.releaseNotes` | Override the release notes with custom notes |
22+
| `gitlab.milestones` | Associate one or more milestones with a GitLab release |
23+
| `gitlab.tokenRef` | GitLab token environment variable name (default: `GITLAB_TOKEN`) |
24+
| `gitlab.tokenHeader` | _TODO_ |
25+
| `gitlab.certificateAuthorityFile` | _TODO_ |
26+
| `gitlab.secure` | _TODO_ |
27+
| `gitlab.assets` | Glob pattern path to assets to add to the GitLab release |
28+
| `gitlab.origin` | _TODO_ |
29+
| `gitlab.skipChecks` | Skip checks on `GITLAB_TOKEN` environment variable and milestone(s) |
30+
1531
## Prerequisite checks
1632

1733
First, release-it will check whether the `GITLAB_TOKEN` environment variable is set. Otherwise it will throw an error

‎docs/npm.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,21 @@ With a `package.json` in the current directory, release-it will let `npm` bump t
77
- If `package.json` should be ignored, its version should not be bumped, and nothing should be published to npm, use
88
`--no-npm` or `"npm": false` in the release-it configuration.
99

10+
## Configuration options
11+
12+
| Option | Description |
13+
| :--------------------- | :----------------------------------------------------------------------------------- |
14+
| `npm.publish` | Set to `false` to skip the npm publish step |
15+
| `npm.publishPath` | Publish only a specific folder (e.g. `dist`) |
16+
| `npm.publishArgs` | In case extra arguments should be provided to npm for the publish operation |
17+
| `npm.tag` | Use e.g. `npm.tag=beta` to tag the package in the npm repository |
18+
| `npm.otp` | The one-time password (OTP) can be provided from the command line (`npm.otp=123456`) |
19+
| `npm.ignoreVersion` | When set to `true`, ignore the `version` from `package.json` |
20+
| `npm.allowSameVersion` | Allow new version to be the same value as the current version |
21+
| `npm.versionArgs` | In case extra arguments should be provided to npm for the versioning operation |
22+
| `npm.skipChecks` | Skip checks on whether the npm registry is up and the user permissions |
23+
| `npm.timeout` | Timeout duration to wait for a response from the npm registry |
24+
1025
## Prerequisite checks
1126

1227
To prevent issues later in the process, release-it first checks whether the npm registry is up, the user is

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