# Milestoner

[![Gem Version](https://badge.fury.io/rb/milestoner.svg)](http://badge.fury.io/rb/milestoner)
[![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/milestoner.svg)](https://codeclimate.com/github/bkuhlmann/milestoner)
[![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/milestoner/coverage.svg)](https://codeclimate.com/github/bkuhlmann/milestoner)
[![Gemnasium Status](https://gemnasium.com/bkuhlmann/milestoner.svg)](https://gemnasium.com/bkuhlmann/milestoner)
[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/milestoner.svg)](https://travis-ci.org/bkuhlmann/milestoner)
[![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)

A command line interface for releasing Git repository milestones.

<!-- Tocer[start]: Auto-generated, don't remove. -->

# Table of Contents

- [Features](#features)
- [Screencasts](#screencasts)
- [Requirements](#requirements)
- [Setup](#setup)
- [Usage](#usage)
  - [Command Line Interface (CLI)](#command-line-interface-cli)
  - [Customization](#customization)
- [Security](#security)
- [Tests](#tests)
- [Versioning](#versioning)
- [Code of Conduct](#code-of-conduct)
- [Contributions](#contributions)
- [License](#license)
- [History](#history)
- [Credits](#credits)

<!-- Tocer[finish]: Auto-generated, don't remove. -->

# Features

- Ensures [Semantic Versioning](http://semver.org) of Git repository tags:
    - Format: `v<major>.<minor>.<maintenance>`.
    - Example: `v0.1.0`.
- Ensures Git commits since last tag (or initialization of repository) are included within each Git tag message.
- Ensures Git commit messages are grouped by prefix, in order defined, for each Git tag message. Prefix defaults (can be
  customized):
    - Fixed
    - Added
    - Updated
    - Removed
    - Refactored
- Ensures Git commit merge messages are excluded within each Git tag message.
- Ensures Git commit messages are alphabetically sorted within each Git tag message.
- Ensures duplicate Git commit messages are removed (if any) within each Git tag message.
- Ensures Git commit messages are sanitized by removing extra spaces and `[ci skip]` text within each Git tag message.
- Provides optional security for signing Git tags with [GnuPG](https://www.gnupg.org) signing key.

# Screencasts

[![asciicast](https://asciinema.org/a/26561.png)](https://asciinema.org/a/26561)

# Requirements

0. A UNIX-based system.
0. [Ruby 2.3.x](https://www.ruby-lang.org).
0. [GnuPG](https://www.gnupg.org).

# Setup

For a secure install, type the following (recommended):

    gem cert --add <(curl --location --silent https://www.alchemists.io/gem-public.pem)
    gem install milestoner --trust-policy MediumSecurity

NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
allowing the installation of unsigned dependencies since they are beyond the scope of this gem.

For an insecure install, type the following (not recommended):

    gem install milestoner

# Usage

## Command Line Interface (CLI)

From the command line, type: `milestoner help`

    milestoner -P, [--publish=PUBLISH]  # Tag and push milestone to remote repository.
    milestoner -c, [--commits]          # Show commits for next milestone.
    milestoner -e, [--edit]             # Edit Milestoner settings in default editor.
    milestoner -h, [--help=HELP]        # Show this message or get help for a command.
    milestoner -p, [--push]             # Push local tag to remote repository.
    milestoner -t, [--tag=TAG]          # Tag local repository with new version.
    milestoner -v, [--version]          # Show Milestoner version.

For tag options, type: `milestoner help tag`

    -s, [--sign], [--no-sign]  # Sign tag with GPG key.

For publish options, type: `milestoner help publish`

    -s, [--sign], [--no-sign]  # Sign tag with GPG key.

When using Milestoner, the `--publish` command is intended to be the only command necessary for publishing a new release
as it handles all of the steps necessary for tagging and pushing a new milestone. Should individual steps be needed,
then the `--tag` and `--push` options are available.

## Customization

Should the default settings not be desired, customization is allowed via the `.milestonerrc` file. The `.milestonerrc`
can be created at a global and/or local level. Example:

- Global: `~/.milestonerrc`
- Local: `<project repository root>/.milestonerrc`

Order of precedence for any setting is resolved as follows (with the last taking top priority):

0. Global `~/.milestonerrc`.
0. Local project repository `.milestonerrc`.
0. CLI option. Example: A version passed to either the `--tag` or `--publish` commands.

Any setting provided to the CLI during runtime would trump a local/global setting and a local setting would trump a
global setting. The global setting is the weakest of all but great for situations where custom settings should be
applied to *all* projects. It is important to note that local settings completely trump any global settings -- there is
no inheritance when local *and* global settings exist at the same time.

The `.milestonerrc` uses the following default settings:

    :version: ""
    :git_commit_prefixes:
      - Fixed
      - Added
      - Updated
      - Removed
      - Refactored
    :git_tag_sign: false

Each `.milestonerrc` setting can be configured as follows:

- `version`: By default it is left blank so you'll be prompted by the CLI. However, it can be nice to bump this version
  prior to each release and have the current version checked into source code at a per project level. The version, if
  set, will be used to tag the repository. If the version is a duplicate, an error will be thrown. When supplying a
  version, use this format: `<major>.<minor>.<maintenance>`. Example: `0.1.0`.
- `git_commit_prefixes`: Should the default prefixes not be desired, you can define Git commit prefixes that match your
  style. *NOTE: Prefix order is important with the first prefix defined taking precedence over the second and so forth.*
  Special characters are allowed for prefixes but should be enclosed in quotes if used. To disable prefix usage
  completely, use an empty array. Example: `:git_commit_prefixes: []`.
- `git_tag_sign`: Defaults to `false` but can be enabled by setting to `true`. When enabled, a Git tag will require GPG
  signing for enhanced security and include a signed signature as part of the Git tag. This is useful for public
  milestones where the author of a milestone can be verified to ensure milestone integrity/security.

# Security

To securely sign your Git tags, install and configure [GPG](https://www.gnupg.org):

    brew install gpg
    gpg --gen-key

When creating your GPG key, choose these settings:

- Key kind: RSA and RSA (default)
- Key size: 4096
- Key validity: 0
- Real Name: `<your name>`
- Email: `<your email>`
- Passphrase: `<your passphrase>`

To obtain your key, run the following and take the part after the forward slash:

    gpg --list-keys | grep pub

Add your key to your global Git configuration in the `[user]` section. Example:

    [user]
      signingkey = <your GPG key>

Now, when publishing a new milestone (i.e. `milestoner --publish <version> --sign`), signing of your Git tag will happen
automatically. You will be prompted for the GPG Passphrase each time but that is to be expected.

# Tests

To test, run:

    bundle exec spec

# Versioning

Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:

- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
- Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
- Major (X.y.z) - Incremented for any backwards incompatible public API changes.

# Code of Conduct

Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By participating in this project
you agree to abide by its terms.

# Contributions

Read [CONTRIBUTING](CONTRIBUTING.md) for details.

# License

Copyright (c) 2015 [Alchemists](https://www.alchemists.io).
Read the [LICENSE](LICENSE.md) for details.

# History

Read the [CHANGELOG](CHANGELOG.md) for details.
Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).

# Credits

Developed by [Brooke Kuhlmann](https://www.alchemists.io) at [Alchemists](https://www.alchemists.io).