Skip to content

Commit 654b8f3

Browse files
authored
docs(librarian): regen CLI docs (#2296)
1 parent a945eb7 commit 654b8f3

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

internal/librarian/doc.go

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,12 @@ according to semver rules. It then delegates all language-specific file
154154
modifications, such as updating a CHANGELOG.md or bumping the version in a pom.xml,
155155
to the configured language-specific container.
156156
157+
If a specific library is configured for release via the '--library' flag, a single
158+
releasable change is needed to automatically calculate a version bump. If there are
159+
no releasable changes since the last release, the '--version' flag should be included
160+
to set a new version for the library. The new version must be "SemVer" greater than the
161+
current version.
162+
157163
By default, 'release init' leaves the changes in your local working directory
158164
for inspection. Use the '--push' flag to automatically commit the changes to
159165
a new branch and create a pull request on GitHub. The '--commit' flag may be
@@ -206,6 +212,7 @@ Flags:
206212
local file path like /path/to/repo. Both absolute and relative paths are
207213
supported. If not specified, will try to detect if the current working directory
208214
is configured as a language repository.
215+
-v enables verbose logging
209216
210217
# release tag-and-release
211218
@@ -239,6 +246,9 @@ Usage:
239246
240247
Flags:
241248
249+
-github-api-endpoint string
250+
The GitHub API endpoint to use for all GitHub API operations.
251+
This is intended for testing and should not be used in production.
242252
-pr string
243253
The URL of a pull request to operate on.
244254
It should be in the format of https://github.com/{owner}/{repo}/pull/{number}.
@@ -250,6 +260,7 @@ Flags:
250260
local file path like /path/to/repo. Both absolute and relative paths are
251261
supported. If not specified, will try to detect if the current working directory
252262
is configured as a language repository.
263+
-v enables verbose logging
253264
254265
# version
255266

0 commit comments

Comments
 (0)