gitter-badger/justrelease

#JustRelease

JustRelease is command line tool to release software libraries hosted on github.com. Justrelease requires no configuration and applies default behavior in each release operation. If you want to customize some of the features offered by justrelease, please include justrelease.yml file in your repository.

##Requirements

• Github Account and Github Repository
• Git in your local computer
• Java 7 or higher
• justrelease.yml for custom configuration

##Installation

• Download and unzip latest zip file
• Generate Personal Access Token
• Create ~/.github file and set login and oauth parameters as below

login=github_username
oauth=GITHUB_OAUTH_TOKEN

##Usage

$ sh justrelease.sh

usage: justrelease <username/repository> <major|minor|patch|X.Y.Z>
 -dryRun                  release without push
 -h                       help
 -snapshotVersion <arg>   version number that will be updated after the
                          release. maven spesific feature

Quick Example

• fork one of sample repositories maven or npm
• update releasenotes.md file and commit the change.
• run sh justrelease.sh yourusername/reponame patch
• check releases page of your forked repository

Advanced Configuration

To configure your release steps you need to create justrelease.yml file in your repo. If you don't create a justrelease.yml file, default configurations will be used.

This is example justrelease.yml file:

version.update:
    - xml
create.artifacts:
        - mvn clean install
publish:
        - github:
            - description:releasenotes.md
            - attachment:target/justrelease-${version}.jar

###Version Update

You need to give file extensions as a config. If you don't provide this step, we automatically detect your project type and use default configurations. Currently we are supporting maven and npm type projects.

An example is following ( you need to put this code snippet to your justrelease.yml file.

version.update:
    - json,js

###Create Artifacts

In this step, you need to provide commands that create artifacts in your project. If you don't provide this configuration, we will use default config according to your project. ( i.e.: For maven mvn clean install )

Example create artifacts config:

create.artifacts:
        - npm install
        - npm test

###Publish

In this step you need to provide publish configuration. Currently we are supporting github publish.

You can give your releasenotes file, and your attachment file. An example is following:

publish:
        - github:
            - description=releasenotes.md
            - attachment=lib/index.js

##How to Use JustRelease Library

###Most Simple Usage:

sh justrelease.sh username/reponame

In this usage we detect your project type, update the version ( we assume it is patch release).

###Giving Release Type

sh justrelease.sh username/reponame (major | minor | patch )

###DryRun Config

If you want to just observe what will happen when releasing you can use DryRun config. In this case, there will be no push or committing. You will see just logs.

sh justrelease.sh username/reponame minor -dryRun