Skip to content

Commit

Permalink
docs: clarify git config option (#103)
Browse files Browse the repository at this point in the history
Co-authored-by: Rick Clark <[email protected]>
  • Loading branch information
rkclark and rkclark authored Apr 5, 2024
1 parent d5d009e commit 824e75f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ $ nx semantic-release app-c --repositoryUrl "https://github.com/TheUnderScorer/n
| repositoryUrl | string | repositoryUrl | no | The URL of the repository to release from. |
| tagFormat | string | ${PROJECT_NAME}-v${version} | no | Tag format to use. You can refer to [semantic-release configuration](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#tagformat) |
| npm | boolean | true | no | Whether to bump package.json version and publish to registry (if package is public). |
| git | boolean | true | no | Whether to create git commit and tag. See more in [@semantic-release/git](https://github.com/semantic-release/git). |
| git | boolean | true | no | Whether to create git commit representing the new version. Setting to false disables the [@semantic-release/git](https://github.com/semantic-release/git) plugin. |
| github | boolean | true | no | Whether to create github release. |
| githubOptions | object | {} | no | Options for [@semantic-release/github](https://github.com/semantic-release/github) plugin |
| buildTarget | string | | no | The target of the build command. If your package is public and you want to release it to npm as part of release, you have to provide it. Plugin will use it to build your package and set version in package.json before releasing it to npm registry. |
Expand Down

0 comments on commit 824e75f

Please sign in to comment.