Skip to content

Commit

Permalink
docs(ref): Update stale negations
Browse files Browse the repository at this point in the history
Fixes #725
  • Loading branch information
epage committed Nov 13, 2023
1 parent 2df2af9 commit 47da8d5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,20 +118,20 @@ Workspace configuration is read from the following (in precedence order)
| `sign-tag` | `--sign-tag` | bool | `false` | Use GPG to sign git tag generated by cargo-release. |
| `registry` | `--registry` | string | \- | Cargo registry name to publish to (default uses Rust's default, which goes to `crates.io`) |
| `release` | `--package` | bool | `true` | Release this crate (usually disabled for internal crates in a workspace) |
| `push` | `--no-push` | bool | `true` | Don't do git push |
| `push` | `--no-push` | bool | `true` | Git push the branch / tags |
| `push-remote` | `--push-remote` | string | `origin` | Default git remote to push |
| `push-options` | \- | list of strings | `[]` | Flags to send to the server when doing a `git push` |
| `shared-version` | \- | bool or string | `false` | Ensure all crates with `shared-version` are the same version. May also be a string to create named subsets of shared versions |
| `consolidate-commits` | \- | bool | `true` | When releasing a workspace, use a single commit for the pre-release version bump. Commit settings will be read from the workspace-config. |
| `pre-release-commit-message` | \- | string | `"chore: Release"` | A commit message template for release. |
| `tag` | `--no-tag` | bool | `true` | Don't do git tag |
| `tag` | `--no-tag` | bool | `true` | Create git tag for the version |
| `tag-message` | \- | string | `"chore: Release {{crate_name}} version {{version}}"` | A message template for an annotated tag (set to blank for lightweight tags). The placeholder `{{tag_name}}` and `{{prefix}}` (the tag prefix) is supported in addition to the global placeholders mentioned below. |
| `tag-prefix` | `--tag-prefix` | string | *depends* | Prefix of git tag, note that this will override default prefix based on crate name. |
| `tag-name` | `--tag-name` | string | `"{{prefix}}v{{version}}"` | The name of the git tag. The placeholder `{{prefix}}` (the tag prefix) is supported in addition to the global placeholders mentioned below. |
| `pre-release-replacements` | \- | array of tables (see below) | `[]` | Specify files that cargo-release will search and replace with new version for the release commit |
| `pre-release-hook` | \- | list of arguments | \- | Provide a command to run before `cargo-release` commits version change. If the return code of hook command is greater than 0, the release process will be aborted. |
| `publish` | `--no-publish` | bool | `true` | Don't do cargo publish right now, see [manifest `publish` field](https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish--field-optional) to permanently disable publish. See `release` for disabling the complete release process. |
| `verify` | `--no-verify` | bool | `true` | Don't verify the contents by building them |
| `publish` | `--no-publish` | bool | `true` | `cargo publish` right now, see [manifest `publish` field](https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish--field-optional) to permanently disable publish. See `release` for disabling the complete release process. |
| `verify` | `--no-verify` | bool | `true` | Verify the contents by building them |
| `owners` | | list of logins | `[]` | Ensure these logins are marked as owners |
| `enable-features` | `--features` | list of names | `[]` | Provide a set of feature flags that should be passed to `cargo publish` (requires rust 1.33+) |
| `enable-all-features` | `--all-features` | bool | `false` | Signal to `cargo publish`, that all features should be used (requires rust 1.33+) |
Expand Down

0 comments on commit 47da8d5

Please sign in to comment.