Metadata-Version: 2.1
Name: gitgerrit
Version: 0.0.13
Summary: Command line tool to interact with gerrit change requests
Home-page: https://github.com/rasjani/gitgerrit
Author: Jani Mikkonen
Author-email: jani.mikkonen@gmail.com
License: Apache License 2.0
Description: git-gerrit
        ==========
        
        Command line to to interact with gerrit codereview service and its ci integrations. Made for internal use but
        could be useful for others too.
        
        
        ## Installation
        
        `pip install gitgerrit`
        
        After the package has been installed, its available via `git gerrit`.
        
        ## Configuration
        
        * Generate HTTP Password in Gerrit web ui.
        * `git config --add gerrit.host hostname.of.your.gerrit.instance`
        * `git config --add gerrit.user your_user_name`
        * `git config --add gerrit.token your_http_password`
        * `git config --add gerrit.prevent_build_topic noci
        
        Or alternative, you can set the same values into following environment variables:
        
        * GERRIT_HOST
        * GERRIT_USER
        * GERRIT_TOKEN
        * GERRIT_PREVENT_BUILD_TOPIC
        
        If you need to modify the the comment used by runverify action, you can optionally add env GERRIT_TRIGGER or gerrit.trigger
        git configuration option. If not set, defaults to `runverify` but you could also set it to `artifactoryupload` on repo basis.
        
        `prevent_build_topic` is a topic that is configured in the ci typically means that commits with that topic will not be build.
        This is helpful when working with commit chains (`--support-chain` flag) and only the HEAD of the relation should be build,
        not all the parents leading to the HEAD.  If not set, defaults to `NOCI`
        
        ## Usage
        
        
        *git-gerrit* either works on current commit of the checked out repository if no `--commit` or `--changeid` wherent provided.
        
        By default, *git-gerrit* operates on a single commit. If you want to apply your actions to each commit that are submitted
        together, provide `--support-chain` argument before action.
        
        you can also specify logging level via --loglevel=$level flag.
        
        After the optional paremters that affect what change requests are being operated on, you need to provide the keyword that defines
        what action is taken against change(s)
        
        ## Actions
        
        ### runverify
        Can either print out the current votes on latest revision of change(s) or adds "runverify" message to the latest revision to
        trigger a ci build of your current changes.
        
        "runverify" trigger message can be customized by setting `gerrit.trigger` git config or by GERRIT_TRIGGER environment variable.
        
        For more details: `git gerrit runverify -h`
        ### topic
        Can set or get topic into change(s)get or set topic on change(s)
        
        For more details: `git gerrit runverify -h`
        ### hashtag
        Get, add or remove hashtag(s) on change(s). `--add` and  `--del` flags be added to command line multiple times in order to add
        or remove multiple hashtags in one call. If no hashtags are given, defaults to adding a current branch name to change(s) list
        of hashtags
        
        For more details: `git gerrit hashtag-h`
        ### wip
        Marks change(s) as Work-In-Progress indicating that no reviewing required at the moment.
        
        For more details: `git gerrit wip -h`
        ### ready
        Marks change(s) as Ready-For-Review indicating that your changes are ready for a review
        
        For more details: `git gerrit ready -h`
        ### private
        Marks change(s) as Private. Only people who have been added as reviewers can see the change(s)
        
        For more details: `git gerrit private -h`
        ### public
        Marks change(s) as Public. Everyone with the access to the project can then see your change(s)
        
        For more details: `git gerrit public -h`
        ### prepare
        Prepares change(s) to be ready for merge. This is a group actions:
         * Marks changes(s) as Ready-For-Review
         * Marks changes(s) as Public
         * Changes all changes(s) expect HEAD topic's into NOCI to avoid multiple builds when merged.
         * Adds HEAD's topic as hashtag to change(s)
        
        For more details: `git gerrit prepare -h`
        ### abandon
        Abandon change(s)
        For more details: `git gerrit abandon -h`
        
        
Keywords: git gerrit ci
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
