diff --git a/docs/cli/build/in-copr.md b/docs/cli/build/in-copr.md index 94bf85bad1..b4e65f8a86 100644 --- a/docs/cli/build/in-copr.md +++ b/docs/cli/build/in-copr.md @@ -35,58 +35,4 @@ for more details). Alternatively you can use copr API token available [here](htt ## Help - Usage: packit build in-copr [OPTIONS] [PATH_OR_URL] - Build selected upstream project in Copr. - - PATH_OR_URL argument is a local path or a URL to the upstream git - repository, it defaults to the current working directory. - - Options: - --wait / --no-wait Wait for the build to finish - --owner TEXT Copr user, owner of the project. (defaults - to username from copr config) - --project TEXT Project name to build in. Will be created if - does not exist. (defaults to the first found - project value in the config file or 'packit- - cli-{repo_name}-{branch/commit}') - --targets TEXT Comma separated list of chroots to build in. - (defaults to 'fedora-rawhide-x86_64') - --description TEXT Description of the project to build in. - --instructions TEXT Installation instructions for the project to - build in. - --list-on-homepage Created copr project will be visible on - copr's home-page. - --preserve-project Created copr project will not be removed - after 60 days. - --additional-repos TEXT URLs to additional yum repos, which can be - used during build. Comma separated. This - should be baseurl from .repo file. E.g.: - http://copr-be.cloud.fedoraproject.org/resul - ts/rhughes/f20-gnome-3-12/fedora-$releasever - -$basearch/ - --bootstrap [default|on|off|image] - mock bootstrap feature setup. - --upstream-ref TEXT Git ref of the last upstream commit in the - current branch from which packit should - generate patches (this option implies the - repository is source-git). - --request-admin-if-needed Ask for admin permissions when we need to - change settings of the copr project and are - not allowed to do so. - --enable-net / --disable-net Copr build is built with explicitly enabled - network access or disabled - --release-suffix TEXT Specifies release suffix. Allows to override - default generated:{current_time}.{sanitized_ - current_branch}{git_desc_suffix} - --default-release-suffix Allows to use default, packit-generated, - release suffix when some release_suffix is - specified in the configuration. - --module-hotfixes Created copr project will have - module_hotfixes set to True - -p, --package TEXT Package to build, if more than one - available, like in a monorepo configuration. - Use it multiple times to select multiple - packages.Defaults to all the packages listed - inside the config. - -h, --help Show this message and exit. diff --git a/docs/cli/build/in-image-builder.md b/docs/cli/build/in-image-builder.md index 52a42b3f28..fcd2e2f023 100644 --- a/docs/cli/build/in-image-builder.md +++ b/docs/cli/build/in-image-builder.md @@ -39,35 +39,4 @@ Builder, for more details see the `vm_image_build` job description. ## Help - Usage: packit build in-image-builder [OPTIONS] IMAGE_NAME [PATH_OR_URL] - Create a VM image in Image Builder. - - ### EXPERIMENTAL ### - - This command is experimental and the integration with Image Builder will be - changed in a backwards incompatible way in the future. - - Packit loads image build configuration from your packit.yaml file. - - When `--job-config-index` is not specified, the job configuration is loaded - from your .packit.yaml and the first matching vm_image_build job is used. - - IMAGE_NAME is the name of the image to be created. Please pick something - unique so it's easy to identify for you in the Image Builder interface and - can be well associated with the image content. - - [PATH_OR_URL] argument is a local path or a URL to the upstream git - repository, it defaults to the current working directory - - Options: - --job-config-index INTEGER Use N-th job definition to load configuration - for the image build. The type needs to be - vm_image_build. - --wait / --no-wait Wait for the build to finish - -p, --package TEXT Package to build, if more than one available, - like in a monorepo configuration. Use it - multiple times to select multiple - packages.Defaults to all the packages listed - inside the config. - -h, --help Show this message and exit. diff --git a/docs/cli/build/in-koji.md b/docs/cli/build/in-koji.md index 701a80a31a..378a93a96b 100644 --- a/docs/cli/build/in-koji.md +++ b/docs/cli/build/in-koji.md @@ -26,37 +26,4 @@ Submit a Koji build for the selected branch in Fedora dist-git. ## Help - Usage: packit build in-koji [OPTIONS] [PATH_OR_URL] - - Build selected upstream project in Fedora. - - By default, packit checks out the respective dist-git repository and - performs `fedpkg build` for the selected branch. With `--from-upstream`, - packit creates a SRPM out of the current checkout and sends it to koji. - - PATH_OR_URL argument is a local path or a URL to the upstream git - repository, it defaults to the current working directory - - Options: - --dist-git-branch TEXT Comma separated list of target branches in dist- - git to release into. (defaults to repo's default - branch) - --dist-git-path TEXT Path to dist-git repo to work in. Otherwise clone - the repo in a temporary directory. - --from-upstream Build the project in koji directly from the - upstream repository - --koji-target TEXT Koji target to build inside (see `koji list- - targets`). - --scratch Submit a scratch koji build - --wait / --no-wait Wait for the build to finish - --release-suffix TEXT Specifies release suffix. Allows to override - default generated:{current_time}.{sanitized_curren - t_branch}{git_desc_suffix} - --default-release-suffix Allows to use default, packit-generated, release - suffix when some release_suffix is specified in - the configuration. - -p, --package TEXT Package to build, if more than one available, like - in a monorepo configuration. Use it multiple times - to select multiple packages.Defaults to all the - packages listed inside the config. - -h, --help Show this message and exit. + diff --git a/docs/cli/build/in-mock.md b/docs/cli/build/in-mock.md index 51510be1b0..15e24f42ee 100644 --- a/docs/cli/build/in-mock.md +++ b/docs/cli/build/in-mock.md @@ -19,31 +19,4 @@ packit build in-mock --root=fedora-40-x86_64 ## Help - Usage: packit build in-mock [OPTIONS] [PATH_OR_URL] - Build RPMs in mock using content of the upstream repository. - - PATH_OR_URL argument is a local path or a URL to the upstream git - repository, it defaults to the current working directory. - - Options: - --upstream-ref TEXT Git ref of the last upstream commit in the current - branch from which packit should generate patches - (this option implies the repository is source- - git). - --release-suffix TEXT Specifies release suffix. Allows to override - default generated:{current_time}.{sanitized_curren - t_branch}{git_desc_suffix} - --default-release-suffix Allows to use default, packit-generated, release - suffix when some release_suffix is specified in - the configuration. - -r, --root TEXT Uses specified chroot configuration. If ends with - '.cfg', then it is treated as full path to the - mock configuration. - --resultdir DIRECTORY Specifies the resultdir option for ‹mock› command, - for details see mock(1) - -p, --package TEXT Package to build, if more than one available, like - in a monorepo configuration. Use it multiple times - to select multiple packages.Defaults to all the - packages listed inside the config. - -h, --help Show this message and exit. diff --git a/docs/cli/build/in-obs.md b/docs/cli/build/in-obs.md index b571c73252..89bad88cdc 100644 --- a/docs/cli/build/in-obs.md +++ b/docs/cli/build/in-obs.md @@ -28,28 +28,4 @@ Submit a build of the present content in the upstream or local repository to [OB ``` ## Help - Usage: packit build in-obs [OPTIONS] [PATH_OR_URL] - - Build selected project in OBS - - Before Running this command, your opensuse user account and password needs - to be configured in osc configuration file ~/.config/osc/oscrc. This can be - done by running `osc`. - - Options: - --owner TEXT OBS user, owner of the project. (defaults to the - username from the oscrc) - --project TEXT Project name to build in. It will be created if does - not exist. It defaults to home:$owner:packit:$pkg - --targets TEXT Comma separated list of chroots to build in. (defaults - to 'fedora-rawhide-x86_64') - --description TEXT Description of the project to build in. - --upstream-ref TEXT Git ref of the last upstream commit in the current - branch from which packit should generate patches (this - option implies the repository is source-git). - --wait / --no-wait Wait for the build to finish - -p, --package TEXT Package to build, if more than one available, like in a - monorepo configuration. Use it multiple times to select - multiple packages.Defaults to all the packages listed - inside the config. - -h, --help Show this message and exit. + diff --git a/docs/cli/build/locally.md b/docs/cli/build/locally.md index f2bbb17e6a..be1387e755 100644 --- a/docs/cli/build/locally.md +++ b/docs/cli/build/locally.md @@ -10,26 +10,4 @@ Create RPMs using content of the upstream repository. ## Help - Usage: packit build locally [OPTIONS] [PATH_OR_URL] - Create RPMs using content of the upstream repository. - - PATH_OR_URL argument is a local path or a URL to the upstream git - repository, it defaults to the current working directory - - Options: - --upstream-ref TEXT Git ref of the last upstream commit in the current - branch from which packit should generate patches - (this option implies the repository is source- - git). - --release-suffix TEXT Specifies release suffix. Allows to override - default generated:{current_time}.{sanitized_curren - t_branch}{git_desc_suffix} - --default-release-suffix Allows to use default, packit-generated, release - suffix when some release_suffix is specified in - the configuration. - -p, --package TEXT Package to build, if more than one available, like - in a monorepo configuration. Use it multiple times - to select multiple packages.Defaults to all the - packages listed inside the config. - -h, --help Show this message and exit. diff --git a/docs/cli/config/validate.md b/docs/cli/config/validate.md index 57f09fa88c..ca320c11db 100644 --- a/docs/cli/config/validate.md +++ b/docs/cli/config/validate.md @@ -10,17 +10,4 @@ Validate the Packit configuration file. ## Help - Usage: packit config validate [OPTIONS] [PATH_OR_URL] - Validate PackageConfig. - - - checks missing values - - checks incorrect types - - checks whether monitoring is enabled if 'pull_from_upstream` is used - - PATH_OR_URL argument is a local path or a URL to a git repository with - packit configuration file - - Options: - --offline Do not make remote API calls requiring network access. - -h, --help Show this message and exit. diff --git a/docs/cli/create-update.md b/docs/cli/create-update.md index e4a1b46b7c..f792adb198 100644 --- a/docs/cli/create-update.md +++ b/docs/cli/create-update.md @@ -44,37 +44,4 @@ have an active Kerberos TGT, you will be automatically authenticated. ## Help - Usage: packit create-update [OPTIONS] [PATH_OR_URL] - Create a bodhi update for the selected upstream project - - If you are not authenticated with the bodhi server, please make sure that - you navigate in your browser to the URL provided by the bodhi-client and - then paste the `code=XX...` to the terminal when prompted. - - If you set `fas_user` and `kerberos_realm` in your "~/.config/packit.yaml" - and have an active Kerberos TGT, you will be automatically authenticated. - Otherwise, you need to follow the prompt - - PATH_OR_URL argument is a local path or a URL to the upstream git - repository, it defaults to the current working directory - - Options: - --dist-git-branch TEXT Comma separated list of target branches in - dist-git to create bodhi update in. - (defaults to repo's default branch) - --dist-git-path TEXT Path to dist-git repo to work in. Otherwise - clone the repo in a temporary directory. - --koji-build TEXT Koji build (NVR) to add to the bodhi update - (can be specified multiple times) - --update-notes TEXT Bodhi update notes - --update-type [security|bugfix|enhancement|newpackage] - Type of the bodhi update - -b, --resolve-bug TEXT Bugzilla IDs that are resolved with the - update, e.g., rhbz#1234 - -p, --package TEXT Package to update, if more than one - available, like in a monorepo configuration. - Use it multiple times to select multiple - packages.Defaults to all the packages listed - inside the config. - -h, --help Show this message and exit. diff --git a/docs/cli/dist-git/init.md b/docs/cli/dist-git/init.md index 6ae06d31b8..d92ef5d0d9 100644 --- a/docs/cli/dist-git/init.md +++ b/docs/cli/dist-git/init.md @@ -9,106 +9,4 @@ Create a Packit's dist-git configuration for release syncing to Fedora. ## Help - Usage: packit dist-git init [OPTIONS] [OTHER_ARGS]... [PATH_OR_URL] - Create the initial Packit dist-git configuration for Fedora release syncing - based on the input parameters. - - This command adds `.packit.yaml` file to the dist-git repository either: - -  1. specified by path (defaults to current working directory) - -  2. specified by URL (`https://src.fedoraproject.org/rpms/`) - - clones the repository and adds the config in there. Ideally use this with - --clone-path option, otherwise the repository is cloned to a temporary - directory that is then removed. - - By default, all 3 jobs (`pull_from_upstream`, `koji_build`, `bodhi_update`) - for release syncing are configured. You can use --no-pull, --no-koji-build - or --no-bodhi-update options to not add some of the jobs. - - You can either create the Packit config file only locally (default), or - create a pull request (using --create-pr option) or push directly to the - dist-git's default branch (--push-to-distgit). - - See 'packit init', if you want to initialize a repository as an upstream - repo. - - Examples - - Local Packit configuration generation for a dist-git repo in the current - working directory: - - - - $ packit dist-git init - - Local Packit configuration generation for a dist-git repo in the current - working directory configuring git URL for cloning of the upstream - repository: - - $ packit dist-git init --upstream-git-url https://github.com/packit/packit . - - Local Packit configuration generation for a dist-git repo specified by URL - that will be cloned to `` dir: - - $ packit dist-git init --clone-path - `` https://src.fedoraproject.org/rpms/packit - - Using arbitrary configuration options that are not provided as the command - options (the working dir needs to be specified in this case): - - $ packit dist-git init --upstream-git-url https://github.com/packit/packit - --my-option option-value . - - Options: - --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) - --dist-git-branches-mapping TEXT - JSON dictionary of target branches in - dist-git to release into for which - `fast_forward_merge_into` syntax will be - used, e.g. '{"fedora-rawhide": ["f39", - "f40"]}'. If not provided and --dist- - git-branches is not provided as well, - defaults to '{"fedora-rawhide": - ["fedora-branched"]}'). - -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. diff --git a/docs/cli/init.md b/docs/cli/init.md index 5c7a97c75b..58f466299a 100644 --- a/docs/cli/init.md +++ b/docs/cli/init.md @@ -17,13 +17,4 @@ initialize a [source-git repo](/source-git). ## Help - Usage: packit init [OPTIONS] [PATH_OR_URL] - Create the initial Packit configuration in a repository - - See 'packit source-git init', if you want to initialize a repository as a - source-git repo. - - Options: - -f, --force Reset config to default if already exists. - -h, --help Show this message and exit. diff --git a/docs/cli/prepare-sources.md b/docs/cli/prepare-sources.md index e6838a98da..1899a39693 100644 --- a/docs/cli/prepare-sources.md +++ b/docs/cli/prepare-sources.md @@ -19,56 +19,4 @@ prepared sources are moved to the `result-dir`. ## Help - Usage: packit prepare-sources [OPTIONS] [PATH_OR_URL] - Prepare sources for a new SRPM build using content of the upstream - repository. Determine version, create an archive or download upstream and - create patches for sourcegit, fix/update the specfile to use the right - archive, download the remote sources. Behaviour can be customized by - specifying actions (post-upstream-clone, get-current-version, create- - archive, create-patches, fix-spec-file) in the configuration. - - PATH_OR_URL argument is a local path or a URL to the upstream git - repository, it defaults to the current working directory - - Options: - --result-dir DIR Copy the sources into DIR. By default, - `prepare_sources_result` directory in the - current working directory is created. - --upstream-ref TEXT Git ref of the last upstream commit in the - current branch from which packit should - generate patches (this option implies the - repository is source-git). - --merged-ref TEXT Git ref used to identify correct most recent - tag. - --update-release / --no-update-release - Specifies whether to update Release. - Defaults to value set in configuration, - which defaults to yes. - --bump / --no-bump Deprecated. Use --[no-]update-release - instead. - --release-suffix TEXT Specifies release suffix. Allows to override - default generated:{current_time}.{sanitized_ - current_branch}{git_desc_suffix} - --default-release-suffix Allows to use default, packit-generated, - release suffix when some release_suffix is - specified in the configuration. - --job-config-index INTEGER Internal option to override package config - found in the repository with job config with - given index (needed for packit service). - --ref TEXT Git reference to checkout. - --pr-id TEXT Specifies PR to checkout. - --merge-pr / --no-merge-pr Specifies whether to merge PR into the base - branch in case pr-id is specified. - --target-branch TEXT Specifies target branch which PR should be - merged into. - --create-symlinks / --no-create-symlinks - Specifies whether Packit should create - symlinks or copy the files (e.g. archive - outside specfile dir). - -p, --package TEXT Package to prepare, if more than one - available, like in a monorepo configuration. - Use it multiple times to select multiple - packages.Defaults to all the packages listed - inside the config. - -h, --help Show this message and exit. diff --git a/docs/cli/propose-downstream.md b/docs/cli/propose-downstream.md index 61a0be4e4c..1f11bd5844 100644 --- a/docs/cli/propose-downstream.md +++ b/docs/cli/propose-downstream.md @@ -73,40 +73,4 @@ Then it copies the files listed in `files_to_sync` (which by default includes th ## Help - Usage: packit propose-downstream [OPTIONS] [PATH_OR_URL] [VERSION] - - Land a new upstream release in Fedora using upstream packit config. - - PATH_OR_URL argument is a local path or a URL to the upstream git - repository, it defaults to the current working directory - - VERSION argument is optional, the latest upstream version will be used by - default - - Options: - --dist-git-branch TEXT Comma separated list of target branches in dist-git - to release into. (defaults to all branches) - --dist-git-path TEXT Path to dist-git repo to work in. Otherwise clone - the repo in a temporary directory. - --force-new-sources Upload the new sources also when the archive is - already in the lookaside cache. - --pr / --no-pr Create a pull request to downstream repository or - push directly. If not set, defaults to value set in - configuration. - -f, --force Don't discard changes in the git repo by default, - unless this is set. - -b, --resolve-bug TEXT Bug(s) that are resolved with the update, e.g., - rhbz#123 (multiple can be specified) - --sync-acls Sync ACLs between dist-git repo and the fork, is - considered only with --pr option. - -p, --package TEXT Package to sync downstream, if more than one - available, like in a monorepo configuration. Use it - multiple times to select multiple packages.Defaults - to all the packages listed inside the config. - --local-content Do not checkout release tag. Use the current state - of the repo. This option is set by default for - source-git repos - --upstream-ref TEXT Git ref of the last upstream commit in the current - branch from which packit should generate patches - (this option implies the repository is source-git). - -h, --help Show this message and exit. + diff --git a/docs/cli/pull-from-upstream.md b/docs/cli/pull-from-upstream.md index 95b71eaa93..334f7befcf 100644 --- a/docs/cli/pull-from-upstream.md +++ b/docs/cli/pull-from-upstream.md @@ -23,34 +23,4 @@ upstream release. This command is meant to be called from **dist-git repository* ## Help - Usage: packit pull-from-upstream [OPTIONS] [PATH_OR_URL] [VERSION] - - Land a new upstream release in Fedora using downstream packit config. - - PATH_OR_URL argument is a local path or a URL to the dist-git repository, it - defaults to the current working directory - - VERSION argument is optional, the latest upstream version will be used by - default - - Options: - --dist-git-branch TEXT Comma separated list of target branches in dist-git - to release into. (defaults to all branches) - --dist-git-path TEXT Path to dist-git repo to work in. Otherwise clone - the repo in a temporary directory. - --force-new-sources Upload the new sources also when the archive is - already in the lookaside cache. - --pr / --no-pr Create a pull request to downstream repository or - push directly. If not set, defaults to value set in - configuration. - -f, --force Don't discard changes in the git repo by default, - unless this is set. - -b, --resolve-bug TEXT Bug(s) that are resolved with the update, e.g., - rhbz#123 (multiple can be specified) - --sync-acls Sync ACLs between dist-git repo and the fork, is - considered only with --pr option. - -p, --package TEXT Package to sync downstream, if more than one - available, like in a monorepo configuration. Use it - multiple times to select multiple packages.Defaults - to all the packages listed inside the config. - -h, --help Show this message and exit. + diff --git a/docs/cli/push-updates.md b/docs/cli/push-updates.md index 8abad558d4..9fd79ddc1a 100644 --- a/docs/cli/push-updates.md +++ b/docs/cli/push-updates.md @@ -19,19 +19,4 @@ have an active Kerberos TGT, you will be automatically authenticated. ## Help - Usage: packit push-updates [OPTIONS] [PATH_OR_URL] - Find all Bodhi updates that have been in testing for more than 'Stable days' - (7 by default) and push them to stable. - - If you are not authenticated with the bodhi server, please make sure that - you navigate in your browser to the URL provided by the bodhi-client and - then paste the `code=XX...` to the terminal when prompted. - - If you set `fas_user` and `kerberos_realm` in your "~/.config/packit.yaml" - and have an active Kerberos TGT, you will be automatically authenticated. - Otherwise, you need to follow the prompt - - Options: - --update-alias TEXT For example FEDORA-2019-ee5674e22c - -h, --help Show this message and exit. diff --git a/docs/cli/scan-in-osh.md b/docs/cli/scan-in-osh.md index 679e8630e8..d00333ee7f 100644 --- a/docs/cli/scan-in-osh.md +++ b/docs/cli/scan-in-osh.md @@ -11,21 +11,4 @@ Builds a SRPM file and performs a scan in [OpenScanHub](https://openscanhub.fedo ## Help - Usage: packit scan-in-osh [OPTIONS] [PATH_OR_URL] - Perform a scan through OpenScanHub. You need a valid Kerberos ticket and set - `dns_canonicalize_hostname=false` in Kerberos configurations. Documentation - can be found at https://fedoraproject.org/wiki/OpenScanHub. - - Options: - -p, --package TEXT Package to build, if more than one available, like in a - monorepo configuration. Use it multiple times to select - multiple packages.Defaults to all the packages listed - inside the config. - --target TEXT Chroot to build in. (defaults to 'fedora- - rawhide-x86_64') - --base-srpm TEXT Base SRPM to perform a differential build against - --base-nvr TEXT Base NVR in Koji to perform a differential build against - --comment TEXT Comment for the build - --csmock-args TEXT Pass additional arguments to csmock - -h, --help Show this message and exit. diff --git a/docs/cli/source-git/init.md b/docs/cli/source-git/init.md index 8283d35bb1..ce8e29f58f 100644 --- a/docs/cli/source-git/init.md +++ b/docs/cli/source-git/init.md @@ -72,48 +72,4 @@ It will be the base of your source-git repository. ## Help - Usage: packit source-git init [OPTIONS] UPSTREAM_REF SOURCE_GIT DIST_GIT - Initialize SOURCE_GIT as a source-git repo by applying downstream patches - from DIST_GIT as Git commits on top of UPSTREAM_REF. - - SOURCE_GIT needs to be an existing clone of the upstream repository. - - UPSTREAM_REF is a tag, branch or commit from SOURCE_GIT. - - SOURCE_GIT and DIST_GIT are paths to the source-git and dist-git repos. - Branch names can be specified, separated by colons. - - If a branch name is specified for SOURCE_GIT, the branch is checked out and - reset to UPSTREAM_REF. - - If a branch name is specified for DIST_GIT, the branch is checked out before - setting up the source-git repo. This branch is expected to exist. - - Each Git commit created in SOURCE_GIT will have a 'From-dist-git-commit' - trailer to mark the hash of the dist-git commit from which it is created. - - To learn more about source-git, please check - - https://packit.dev/docs/source-git/ - - Examples: - - $ packit source-git init v2.3.1 src/acl:rawhide rpms/acl:rawhide - $ packit source-git init --pkg-tool centpkg v2.3.1 src/acl rpms/acl - - Options: - --upstream-url TEXT Git URL of the upstream repository. It is saved in - the source-git configuration if it is specified. - --upstream-remote TEXT Name of the remote pointing to the upstream - repository. If --upstream-url is not specified, the - fetch URL of this remote is saved in the source-git - configuration as the Git URL of the upstream - project. Defaults to 'origin'. - --pkg-tool TEXT Name or path of the packaging tool used to work with - sources in the dist-git repo. A variant of 'rpkg'. - Defaults to 'fedpkg' or the tool configured in the - Packit configuration. - --pkg-name TEXT The name of the package in the distro. Defaults to - the directory name of DIST_GIT. - -h, --help Show this message and exit. diff --git a/docs/cli/source-git/status.md b/docs/cli/source-git/status.md index fa103ed1a3..6229f6012b 100644 --- a/docs/cli/source-git/status.md +++ b/docs/cli/source-git/status.md @@ -16,17 +16,4 @@ how to sync the repositories. ## Help - Usage: packit source-git status [OPTIONS] SOURCE_GIT DIST_GIT - Tell the synchronization status of a source-git and a dist-git repo. - - This command checks the commit history in the provided source-git and dist- - git repos and informs about the range of commits to be synchronized from - dist-git to source-git or the other way around, or informs that the - repositories are in sync. - - If possible, the status command also provides instructions on how to - synchronize the repositories. - - Options: - -h, --help Show this message and exit. diff --git a/docs/cli/source-git/update-dist-git.md b/docs/cli/source-git/update-dist-git.md index 92d32d5c83..6c41bc6600 100644 --- a/docs/cli/source-git/update-dist-git.md +++ b/docs/cli/source-git/update-dist-git.md @@ -11,55 +11,4 @@ update the corresponding dist-git repository. ## Help - Usage: packit source-git update-dist-git [OPTIONS] SOURCE_GIT DIST_GIT - Update a dist-git repository using content from a source-git repository - - Update a dist-git repository with patches created from the commits between - and the current HEAD of the source-git repo. - - This command, by default, performs only local operations and uses the - content of the source-git and dist-git repository as it is: does not - checkout branches or fetches remotes. - - A commit in dist-git is created only if a commit message is provided with - --message or --file. This commit will have a 'From-source-git-commit' Git- - trailer appended to it, to mark the hash of the source-git commit from which - it is created. - - The source archives are retrieved from the upstream URLs specified in the - spec-file and uploaded to the lookaside cache in dist-git only if '--pkg- - tool' is specified. - - Examples: - - To update a dist-git repo from source-git without uploading the source- - archive to the lookaside cache and creating a commit with the updates, run: - - $ packit source-git update-dist-git src/curl rpms/curl - - To also commit the changes and upload the source-archive to the lookaside- - cache specify -m and --pkg-tool: - - $ packit source-git update-dist-git -m'Update from source-git' \ - --pkg-tool fedpkg src/curl rpms/curl - - Options: - --upstream-ref TEXT Git ref of the last upstream commit in the current - branch from which packit should generate patches (this - option implies the repository is source-git). - --pkg-tool TEXT Name or path of the packaging tool used to work with - sources in the dist-git repo. A variant of 'rpkg'. - - Skip retrieving and uploading source archives to the - lookaside cache if not specified. - -m, --message Commit the changes in the dist-git repository and use - as the commit message. - - Mutually exclusive with -F. - -F, --file Commit the changes in the dist-git repository and take - the commit message from . Use - to read from the - standard input. - -f, --force Don't check the synchronization status of the source- - git and dist-git repos prior to performing the update. - -h, --help Show this message and exit. diff --git a/docs/cli/source-git/update-source-git.md b/docs/cli/source-git/update-source-git.md index 426895e292..c40cd8c20a 100644 --- a/docs/cli/source-git/update-source-git.md +++ b/docs/cli/source-git/update-source-git.md @@ -17,51 +17,4 @@ packaging work is going to happen there. ## Help - Usage: packit source-git update-source-git [OPTIONS] DIST_GIT SOURCE_GIT - [REVISION_RANGE] - Update a source-git repository based on a dist-git repository. - - Update a source-git repository with the selected checkout of a spec file and - additional packaging files from a dist-git repository. - - Revision range represents part of dist-git history which is supposed to be - synchronized. Use `HEAD~..` if you want to synchronize the last commit from - dist-git. For more information on possible revision range formats, see - gitrevisions(7). If the revision range is not specified, dist-git commits - with no counterpart in source-git will be synchronized. - - If patches or the sources file in the spec file changed, the command exits - with return code 2. Such changes are not supported by this command, code - changes should happen in the source-git repo. - - Inapplicable changes to the .gitignore file are ignored since the file may - not be synchronized between dist-git and source-git. - - This command, by default, performs only local operations and uses the - content of the source-git and dist-git repositories as it is, no checkout or - fetch is performed. - - After the synchronization is done, packit will inform about the changes it - has performed and about differences between source-git and dist-git prior to - the synchronization process. - - Dist-git commit messages are preserved and used when creating new source-git - commits, but a 'From-dist-git-commit' trailer is appended to them to mark - the hash of the dist-git commit from which they are created. - - Examples - - Take the extra (not synchronized) commit(s) of systemd dist-git repo and - copy the spec file and other packaging files into the source-git repo: - - $ packit source-git update-source-git rpms/systemd src/systemd - - Synchronize changes from the last three dist-git commits: - - $ packit source-git update-source-git rpms/systemd src/systemd HEAD~3.. - - Options: - -f, --force Don't check the synchronization status of the source-git and - dist-git repos prior to performing the update. - -h, --help Show this message and exit. diff --git a/docs/cli/srpm.md b/docs/cli/srpm.md index 0595ebb637..9dca726a20 100644 --- a/docs/cli/srpm.md +++ b/docs/cli/srpm.md @@ -68,35 +68,4 @@ actions: ## Help - Usage: packit srpm [OPTIONS] [PATH_OR_URL] - Create new SRPM (.src.rpm file) using content of the upstream repository. - - PATH_OR_URL argument is a local path or a URL to the upstream git - repository, it defaults to the current working directory - - Options: - --output FILE Write the SRPM to FILE instead of current - dir. - --upstream-ref TEXT Git ref of the last upstream commit in the - current branch from which packit should - generate patches (this option implies the - repository is source-git). - --update-release / --no-update-release - Specifies whether to update Release. - Defaults to value set in configuration, - which defaults to yes. - --bump / --no-bump Deprecated. Use --[no-]update-release - instead. - --release-suffix TEXT Specifies release suffix. Allows to override - default generated:{current_time}.{sanitized_ - current_branch}{git_desc_suffix} - --default-release-suffix Allows to use default, packit-generated, - release suffix when some release_suffix is - specified in the configuration. - -p, --package TEXT Package to source build, if more than one - available, like in a monorepo configuration. - Use it multiple times to select multiple - packages.Defaults to all the packages listed - inside the config. - -h, --help Show this message and exit. diff --git a/docs/cli/status.md b/docs/cli/status.md index 9961b23dbe..e5e19b1538 100644 --- a/docs/cli/status.md +++ b/docs/cli/status.md @@ -12,20 +12,4 @@ pull requests, upstream releases, builds in Koji and Copr and updates in Bodhi. ## Help - Usage: packit status [OPTIONS] [PATH_OR_URL] - Display status. - - - latest downstream pull requests - - versions from all downstream branches - - latest upstream releases - - latest builds in Koji - - latest builds in Copr - - latest updates in Bodhi - - Options: - -p, --package TEXT Package to update, if more than one available, like in a - monorepo configuration. Use it multiple times to select - multiple packages.Defaults to all the packages listed - inside the config. - -h, --help Show this message and exit. diff --git a/docs/cli/sync-from-downstream.md b/docs/cli/sync-from-downstream.md index b82c62d0e1..e11fd87f54 100644 --- a/docs/cli/sync-from-downstream.md +++ b/docs/cli/sync-from-downstream.md @@ -80,29 +80,4 @@ PR created: https://api.github.com/repos/phracek/colin/pulls/3 ## Help - Usage: packit sync-from-downstream [OPTIONS] [PATH_OR_URL] - - Copy synced files from Fedora dist-git into upstream by opening a pull - request. - - PATH_OR_URL argument is a local path or a URL to the upstream git - repository, it defaults to the current working directory - Options: - --dist-git-branch TEXT Comma separated list of target branches in dist-git - to sync from. (defaults to repo's default branch) - --upstream-branch TEXT Target branch in upstream to sync to. (defaults to - repo's default branch) - --no-pr Do not create a pull request to upstream repository. - --fork / --no-fork Push to a fork before creating a pull request. - --remote-to-push TEXT Name of the remote where packit should push. If this - is not specified, push to a fork if the repo can be - forked. - -f, --force Don't discard changes in the git repo by default, - unless this is set. - -p, --package TEXT Package to sync back, if more than one available, - like in a monorepo configuration. Use it multiple - times to select multiple packages.Defaults to all - the packages listed inside the config. - -x, --exclude TEXT File to exclude from sync - -h, --help Show this message and exit.