From b546b61d920270c06c0d2ce778c7984d69b14c14 Mon Sep 17 00:00:00 2001 From: Ivan Shcheklein Date: Tue, 26 Sep 2023 15:43:04 -0700 Subject: [PATCH] fix(gto): update push option descriptions (#4879) --- content/docs/gto/command-reference/assign.md | 4 +++- content/docs/gto/command-reference/deprecate.md | 4 +++- content/docs/gto/command-reference/register.md | 4 +++- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/content/docs/gto/command-reference/assign.md b/content/docs/gto/command-reference/assign.md index 784ff50b9f..1b8cc027b6 100644 --- a/content/docs/gto/command-reference/assign.md +++ b/content/docs/gto/command-reference/assign.md @@ -40,7 +40,9 @@ GTO creates a special Git tag in - `--simple ` - Use simple notation, e.g. `rf#prod` instead of `rf#prod-5` [supported values: auto, true, false] [default: auto] - `--force` - Create the Git tag even if it already exists and is in effect -- `--push` - Push created tag automatically (experimental) +- `--push` - Push created git tag to `origin`. The value is ignored if the + `repo` option is set to a remote URL. In that case tags are pushed to or + created on the remote repo automatically. - `--sr`, `--skip-registration` - Don't register a version at specified commit - `-h`, `--help` - Show this message and exit. diff --git a/content/docs/gto/command-reference/deprecate.md b/content/docs/gto/command-reference/deprecate.md index 58cca59bc5..238c97a146 100644 --- a/content/docs/gto/command-reference/deprecate.md +++ b/content/docs/gto/command-reference/deprecate.md @@ -137,5 +137,7 @@ git push origin awesome-model@v0.0.1 awesome-model#prod#1 awesome-model#prod!#2 [supported values: auto, true, false] [default: auto] - `--force` - Create the Git tag even if it already exists and is in effect - `-d`, `--delete` - Delete the git tag(s) instead of creating the new one -- `--push` - Push created tag automatically (experimental) +- `--push` - Push created git tag to `origin`. The value is ignored if the + `repo` option is set to a remote URL. In that case tags are pushed to or + created on the remote repo automatically. - `-h`, `--help` - Show this message and exit. diff --git a/content/docs/gto/command-reference/register.md b/content/docs/gto/command-reference/register.md index 8621e78060..2ab1a2edf6 100644 --- a/content/docs/gto/command-reference/register.md +++ b/content/docs/gto/command-reference/register.md @@ -45,7 +45,9 @@ another Git commit if you provide it's hexsha as an additional argument, like - `--bump-major` - Bump major version - `--bump-minor` - Bump minor version - `--bump-patch` - Bump patch version -- `--push` - Push created tag automatically (experimental) +- `--push` - Push created git tag to `origin`. The value is ignored if the + `repo` option is set to a remote URL. In that case tags are pushed to or + created on the remote repo automatically. - `-h`, `--help` - Show this message and exit. ## Examples