.. _sample-rpkg:

sample-rpkg
===========

.. program:: sample-rpkg

Synopsis
--------

::

    sample-rpkg [ global_options ] command [ command_options ] [ command_arguments ]
    sample-rpkg help
    sample-rpkg command --help

Description
-----------

sample-rpkg is a library to build command line appliaction to build RPM, container
and module locally or in remote build system.

Global Options
--------------

.. option:: -h, --help

   show this help message and exit

.. option:: --config CONFIG, -C CONFIG

   Specify a config file to use

.. option:: --release RELEASE

   Override the discovered release from current branch, which is used to determine the build target and value of dist macro. Generally, release is the name of a branch created in your package repository. --release is an alias of --dist, hence --release should be used instead.

.. option:: --dist DIST

   Deprecated. Use --release instead. You can use --dist for a while for backward-compatibility. It will be disabled in future version.

.. option:: --module-name MODULE_NAME

   Override the module name. Otherwise it is discovered from: Git push URL or Git URL (last part of path with .git extension removed) or from name macro in spec file. In that order.

.. option:: --user USER

   Override the discovered user name

.. option:: --password PASSWORD

   Password for Koji login

.. option:: --runas RUNAS

   Run Koji commands as a different user

.. option:: --path PATH

   Define the directory to work in (defaults to cwd)

.. option:: --verbose, -v

   Run with verbose debug output

.. option:: --debug, -d

   Run with debug output

.. option:: -q

   Run quietly only displaying errors



Commands
--------

**sample-rpkg-help**
  Show usage

**sample-rpkg-build**
  Request build

**sample-rpkg-chain-build**
  Build current package in order with other packages

**sample-rpkg-clean**
  Remove untracked files

**sample-rpkg-clog**
  Make a clog file containing top changelog entry

**sample-rpkg-clone**
  Clone and checkout a module

**sample-rpkg-co**
  Alias for clone

**sample-rpkg-copr-build**
  Build package in Copr

**sample-rpkg-commit**
  Commit changes

**sample-rpkg-ci**
  Alias for commit

**sample-rpkg-compile**
  Local test rpmbuild compile

**sample-rpkg-container-build**
  Build a container

**sample-rpkg-container-build-setup**
  set options for container-build

**sample-rpkg-diff**
  Show changes between commits, commit and working tree, etc

**sample-rpkg-gimmespec**
  Print the spec file name

**sample-rpkg-gitbuildhash**
  Print the git hash used to build the provided n-v-r

**sample-rpkg-giturl**
  Print the git url for building

**sample-rpkg-import**
  Import srpm content into a module

**sample-rpkg-install**
  Local test rpmbuild install

**sample-rpkg-lint**
  Run rpmlint against local spec and build output if present.

**sample-rpkg-local**
  Local test rpmbuild binary

**sample-rpkg-mockbuild**
  Local test build using mock

**sample-rpkg-mock-config**
  Generate a mock config

**sample-rpkg-module-build**
  Build a module using MBS

**sample-rpkg-module-build-cancel**
  Cancel an MBS module build

**sample-rpkg-module-build-info**
  Show information of an MBS module build

**sample-rpkg-module-build-local**
  Build a module locally using the mbs-manager command

**sample-rpkg-module-build-watch**
  Watch an MBS build

**sample-rpkg-module-overview**
  Shows an overview of MBS builds

**sample-rpkg-new**
  Diff against last tag

**sample-rpkg-new-sources**
  Upload source files

**sample-rpkg-patch**
  Create and add a gendiff patch file

**sample-rpkg-prep**
  Local test rpmbuild prep

**sample-rpkg-pull**
  Pull changes from the remote repository and update the working copy.

**sample-rpkg-push**
  Push changes to remote repository

**sample-rpkg-scratch-build**
  Request scratch build

**sample-rpkg-sources**
  Download source files

**sample-rpkg-srpm**
  Create a source rpm

**sample-rpkg-switch-branch**
  Work with branches

**sample-rpkg-tag**
  Management of git tags

**sample-rpkg-unused-patches**
  Print list of patches not referenced by name in the specfile

**sample-rpkg-upload**
  Upload source files

**sample-rpkg-verify-files**
  Locally verify %%files section

**sample-rpkg-verrel**
  Print the name-version-release


Reporting Bugs
--------------

Login and create a issue from https://pagure.io/rpkg/issues/.

Notes
-----

* Source code: https://pagure.io/rpkg
* Documentation: https://docs.pagure.org/rpkg/