Skip to content

Commit

Permalink
Update help messages of CLI commands (#886)
Browse files Browse the repository at this point in the history
Update help messages of CLI commands

Automatically regenerated help messages for CLI command docs.

Reviewed-by: Laura Barcziová
  • Loading branch information
softwarefactory-project-zuul[bot] authored May 21, 2024
2 parents 69c5569 + f33fced commit 9034069
Showing 1 changed file with 41 additions and 38 deletions.
79 changes: 41 additions & 38 deletions docs/cli/dist-git/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,41 +55,44 @@ Create a Packit's dist-git configuration for release syncing to Fedora.
--my-option option-value .

Options:
--upstream-git-url TEXT URL to the upstream GIT repository [required]
--upstream-tag-template TEXT Template applied for upstream tags if they
differ from versions. E.g. 'v{version}'
--upstream-tag-include TEXT Python regex used for filtering upstream tags
to include.
--upstream-tag-exclude TEXT Python regex used for filtering upstream tags
to exclude.
--version-update-mask TEXT Python regex used for comparison of the old
and the new version.
--issue-repository TEXT URL of a git repository that can be used for
reporting errors in form of issues.
--no-pull Do not include the pull from upstream job in
the config
--no-koji-build Do not include the Koji build job in the
config
--allowed-committers TEXT Comma separated list of allowed_committers
used for Koji builds
--allowed-pr-authors TEXT Comma separated list of allowed_pr_authors
used for Koji builds
--no-bodhi-update Do not include the Bodhi update job in the
config
--actions-file FILE Yaml file with 'actions' that should be used
for the config
--dist-git-branches TEXT Comma separated list of target branches in
dist-git to release into. (defaults to
rawhide)
-p, --push-to-distgit Push the generated Packit config to the dist-
git repository's rawhide
-c, --create-pr Create a PR with generated Packit config
-f, --force Reset config to default if already exists.
--clone-path TEXT Path to clone the dist-git repo into (if
path_or_url is URL). Otherwise clone the repo
in a temporary directory.
--commit-msg TEXT Commit message used when creating a PR (also
for the title) or pushing to dist-git.
Default: 'Add Packit configuration for
automating release syncing'
-h, --help Show this message and exit.
--upstream-git-url TEXT URL to the upstream GIT repository
--upstream-git-url-command TEXT
Command to get the URL of the upstream git
repository
--upstream-tag-template TEXT Template applied for upstream tags if they
differ from versions. E.g. 'v{version}'
--upstream-tag-include TEXT Python regex used for filtering upstream
tags to include.
--upstream-tag-exclude TEXT Python regex used for filtering upstream
tags to exclude.
--version-update-mask TEXT Python regex used for comparison of the old
and the new version.
--issue-repository TEXT URL of a git repository that can be used for
reporting errors in form of issues.
--no-pull Do not include the pull from upstream job in
the config
--no-koji-build Do not include the Koji build job in the
config
--allowed-committers TEXT Comma separated list of allowed_committers
used for Koji builds
--allowed-pr-authors TEXT Comma separated list of allowed_pr_authors
used for Koji builds
--no-bodhi-update Do not include the Bodhi update job in the
config
--actions-file FILE Yaml file with 'actions' that should be used
for the config
--dist-git-branches TEXT Comma separated list of target branches in
dist-git to release into. (defaults to
rawhide)
-p, --push-to-distgit Push the generated Packit config to the
dist-git repository's rawhide
-c, --create-pr Create a PR with generated Packit config
-f, --force Reset config to default if already exists.
--clone-path TEXT Path to clone the dist-git repo into (if
path_or_url is URL). Otherwise clone the
repo in a temporary directory.
--commit-msg TEXT Commit message used when creating a PR (also
for the title) or pushing to dist-git.
Default: 'Add Packit configuration for
automating release syncing'
-h, --help Show this message and exit.

0 comments on commit 9034069

Please sign in to comment.