.. _rez-release:

===========
rez-release
===========

.. program:: rez-release

Usage
=====

.. code-block:: text

   rez release [-h] [-m MESSAGE] [--vcs {git,hg,stub}] [--no-latest]
                      [--ignore-existing-tag] [--skip-repo-errors] [--no-message]
                      [--process {local,remote}] [-b BUILDSYS]
                      [--variants INDEX [INDEX ...]] [--ba ARGS] [--cba ARGS]
                      [-v]
   

description
===========

Build a package from source and deploy it.


Options
=======

.. option:: -m, --message 

   release message

.. option:: --vcs 

   force the vcs type to use

   **Choices**: ``git``, ``hg``, ``stub``

.. option:: --no-latest 

   allows release of version earlier than the latest release.

.. option:: --ignore-existing-tag 

   perform the release even if the repository is already tagged at the current version. If the config setting plugins.release_vcs.check_tag is false, this option has no effect.

.. option:: --skip-repo-errors 

   release even if repository-related errors occur. DO NOT use this option unless you absolutely must release a package, despite there being a problem (such as inability to contact the repository server)

.. option:: --no-message 

   do not prompt for release message.

.. option:: --process 

   the build process to use .

   **Choices**: ``local``, ``remote``

   **Default**: ``local``

.. option:: -b, --build-system 

   the build system to use. If not specified, it is detected. Set ``build_system`` or ``build_command`` to specify the build system in the package itself.

.. option:: --variants <index>

   select variants to build (zero-indexed).

.. option:: --ba, --build-args <args>

   arguments to pass to the build system. Alternatively, list these after a ``--``.

.. option:: --cba, --child-build-args <args>

   arguments to pass to the child build system, if any. Alternatively, list these after a second ``--``.

.. option:: -v, --verbose 

   verbose mode, repeat for more verbosity