Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify git config option #103

Merged
merged 1 commit into from
Apr 5, 2024
+1 −1
Merged

docs: clarify git config option #103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
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
Loading