Metadata-Version: 1.0
Name: rhcephpkg
Version: 1.8.0
Summary: Packaging tool for Red Hat Ceph Storage product
Home-page: https://github.com/red-hat-storage/rhcephpkg
Author: Ken Dreyer
Author-email: kdreyer@redhat.com
License: MIT
Description: ``rhcephpkg``
        =============
        
        .. image:: https://travis-ci.org/red-hat-storage/rhcephpkg.svg?branch=master
                  :target: https://travis-ci.org/red-hat-storage/rhcephpkg
        
        .. image:: https://badge.fury.io/py/rhcephpkg.svg
                     :target: https://badge.fury.io/py/rhcephpkg
        
        A tool to package and build Red Hat Ceph Storage for Ubuntu.
        
        ``rhcephpkg`` is a command-line tool similar to Red Hat's "rpkg" family of
        tools, like `fedpkg
        <https://fedoraproject.org/wiki/Package_maintenance_guide>`_ (open-source) or
        rhpkg (closed-source). In Red Hat we use this to package and build the RH Ceph
        Enterprise product for Ubuntu.
        
        Configuration
        -------------
        
        ``$HOME/.rhcephpkg.conf`` should contain the following::
        
          [rhcephpkg]
          user=kdreyer
          gitbaseurl = ssh://%(user)s@code.engineering.redhat.com/rcm/ceph-ubuntu/%(module)s
          anongiturl = git://git.app.eng.bos.redhat.com/rcm/ceph-ubuntu/%(module)s.git
          patchesbaseurl = ssh://%(user)s@code.engineering.redhat.com/%(module)s
        
          [rhcephpkg.jenkins]
          token=5d41402abc4b2a76b9719d911017c592
          url=https://rcm-jenkins.app.eng.bos.redhat.com/
        
          [rhcephpkg.chacra]
          url=https://ubuntu-ceph-test.brew.prod.eng.bos.redhat.com/
        
        Substitute your settings:
        
        * ``user`` is your Red Hat Kerberos UID
        * ``token`` is your API token from Jenkins. To find this value, log into Jenkins' Web UI (using your Kerberos username + password)
        
        Commands
        --------
        
        * ``rhcephpkg clone`` - clone a "dist-git" repository. You must have a valid
          Kerberos ticket.
        
          We use Git repositories with layouts that interoperate with Debian's
          `git-buildpackage
          <http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.html>`_
          suite of tools.
        
          The ``clone`` operation uses your SSH key, which must be configured in
          Gerrit.
        
        * ``rhcephpkg build`` - Trigger a build in Jenkins.
        
        * ``rhcephpkg checkout-from-patches`` - Choose a Debian branch based on a RHEL
          `rdopkg <https://github.com/softwarefactory-project/rdopkg>`_-style
          "patches" branch.
        
        * ``rhcephpkg download`` - Download a build's artifacts from chacra.
        
        * ``rhcephpkg hello`` - Test Jenkins authentication. Use this to verify your
          ``user`` and ``token`` settings.
        
        * ``rhcephpkg gitbz`` - Verify each RHBZ in the last Git commit message.
        
        * ``rhcephpkg localbuild`` - Perform a local build using pbuilder.
        
        * ``rhcephpkg merge-patches`` - Do a merge from the RHEL `rdopkg
          <https://github.com/softwarefactory-project/rdopkg>`_-style
          "patches" remote branch to the Ubuntu patch-queue branch.
        
        * ``rhcephpkg new-version`` - Import a new upstream version of a package.
        
        * ``rhcephpkg patch`` - Apply a patch-queue branch to a package.
        
        * ``rhcephpkg source`` - Build a source package on the local system.
        
        * ``rhcephpkg watch-build`` - Watch a build-package job in Jenkins.
        
        Installing
        ----------
        
        Pre-built Ubuntu Trusty and Xenial packages are available::
        
          sudo apt-get update
          sudo apt-get -y install software-properties-common
          sudo apt-add-repository ppa:kdreyer-redhat/rhceph
          sudo apt-get update
          sudo apt-get install rhcephpkg
        
        Developing rhcephpkg
        --------------------
        
        See ``HACKING.rst`` to get started with running rhcephpkg directly from Git.
        
        TODO
        ----
        
        * ``rhcephpkg push`` - Runs ``git push origin --tags`` and then
          ``git push origin``. This will help with CI during rebases, so that
          Jenkins (via Gerrit) will pick up the branch change only after the new tags
          are already present.
        
        * ``rhcephpkg dch`` - Bump the changelog according to our "redhat" version
          number change pattern. This will help make rebases faster.
        
        * ``rhcephpkg amend`` - Amend the last Git commit to make the commit
          message align with the last ``debian/changelog`` entry. This would be similar
          to how ``rdopkg amend`` works (and some of this functionality is already
          present in ``rhcephpkg patch``).
        
Keywords: packaging,build,rpkg
Platform: UNKNOWN
