Metadata-Version: 2.1
Name: lase
Version: 0.3.0
Summary: Gitflow release tool
Home-page: https://github.com/node13h/lase
Author: Sergej Alikov
Author-email: sergej.alikov@gmail.com
License: UNKNOWN
Description: # lase - Gitflow release tool
        
        
        ## Installing
        
        ```sh
        pip install lase
        ```
        
        
        ## Using
        
        Prerequisites:
        
        - Git-based project with `master` and `develop` branches present, and Maven-style version
          number in the `VERSION` file
        
        
        See `lase --help` for the list of all options.
        
        
        ### Starting a release of your project with remote operation enabled
        
        ```sh
        cd /path/to/project/git/repo
        lase --remote origin start
        ```
        
        The above command will, and create the `release/X.Y.Z` release branch where `X.Y.Z` is the version
        being released, bumping the version in the `VERSION` file on the `develop` branch at the same time.
        
        After reviewing the diff between the release and `master` branches proceed to the finish step below.
        
        ### Finishing a release of a your project with remote operation enabled
        
        ```sh
        cd /path/to/project/git/repo
        lase --remote origin finish
        ```
        
        
        ## Developing
        
        Prerequisites:
        
        - Python 3
        - [pipenv](https://docs.pipenv.org/en/latest/#install-pipenv-today)
        
        Initialize a virtualenv with dev dependencies installed:
        
        ```sh
        make develop
        ```
        
        
        ### Project dependencies
        
        Project dependencies shoud always be specified in `setup.py` using the
        [compatible release](https://www.python.org/dev/peps/pep-0440/#compatible-release)
        notation.
        
        
        ### Updating dependencies in virtualenv
        
        Run the following after updating `setup.py`
        
        ```sh
        make update-deps
        ```
        
        
        ### Installing development dependencies
        
        Replace `<PACKAGE>` with the actual name, and `<VERSION>` with the MAJOR.MINOR
        (or MAJOR.MINOR.PATCH for versions below 1.0.0) version of the package.
        [Read more on compatible releases](https://www.python.org/dev/peps/pep-0440/#compatible-release).
        
        ```sh
        pipenv install --dev <PACKAGE>~=<VERSION>
        ```
        
        
        ### Running unit-tests
        
        ```sh
        make test
        ```
        
        
        ### Running E2E tests
        
        Prerequisites:
        
        - [Shelter](https://github.com/node13h/shelter)
        
        ```sh
        make e2e-test
        ```
        
        
        ### Starting a release
        
        Variables:
        
        - `RELEASE_REMOTE` set to the name of the Git remote. Set to empty to disable pushes to
        remote. Default value: `origin`
        - `RELEASE_VERSION` override the release version, or leave empty to release the current
        snapshot (`-SNAPSHOT` will be stripped off). Empty by default
        
        ```sh
        make release-start
        ```
        
        
        ### Finishing a release
        
        Variables:
        
        - `RELEASE_REMOTE` set to the name of the Git remote. Set to empty to disable pushes to
        remote. Default value: `origin`
        - `RELEASE_PUBLISH` - set to `1` to enable publishing of the sdist tarball after the release`
        
        ```sh
        make release-finish
        ```
        
        `release-finish` will leave the release Git tag checked out on completion.
        
        
        ### Building and publishing the source distribution:
        
        ```sh
        make publish
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
