view release on metacpan or  search on metacpan

README.md  view on Meta::CPAN

# NAME

App::git::ship - Git command for shipping your project

# VERSION

0.37

# SYNOPSIS

See ["SYNOPSIS" in App::git::ship::perl](https://metacpan.org/pod/App%3A%3Agit%3A%3Aship%3A%3Aperl#SYNOPSIS) for how to build Perl projects.

Below is a list of useful git aliases:

    # git build
    $ git config --global alias.build 'ship build'

    # git cl
    $ git config --global alias.cl 'ship clean'

    # git start
    # git start My/Project.pm
    $ git config --global alias.start 'ship start'

# DESCRIPTION

[App::git::ship](https://metacpan.org/pod/App%3A%3Agit%3A%3Aship) is a [git](http://git-scm.com/) command for building and
shipping your project.

The main focus is to automate away the boring steps, but at the same time not
get in your (or any random contributor's) way. Problems should be solved with
sane defaults according to standard rules instead of enforcing more rules.

[App::git::ship](https://metacpan.org/pod/App%3A%3Agit%3A%3Aship) differs from other tools like [dzil](https://metacpan.org/pod/Dist%3A%3AZilla) by _NOT_
requiring any configuration except for a file containing the credentials for
uploading to CPAN.

## Supported project types

Currently, only [App::git::ship::perl](https://metacpan.org/pod/App%3A%3Agit%3A%3Aship%3A%3Aperl) is supported.

# ENVIRONMENT VARIABLES

Environment variables can also be set in a config file named `.ship.conf`, in
the root of the project directory. The format is:

    # some comment
    bugtracker = whatever
    new_version_format = %v %Y-%m-%dT%H:%M:%S%z

Any of the keys are the lower case version of ["ENVIRONMENT VARIABLES"](#environment-variables), but
without the "GIT\_SHIP\_" prefix.

Note however that all environment variables are optional, and in many cases
[App::git::ship](https://metacpan.org/pod/App%3A%3Agit%3A%3Aship) will simply do the right thing, without any configuration.

## GIT\_SHIP\_AFTER\_SHIP

It is possible to add hooks. These hooks are
programs that runs in your shell. Example hooks:

    GIT_SHIP_AFTER_SHIP="bash script/new-release.sh"
    GIT_SHIP_AFTER_BUILD="rm -r lib/My/App/templates lib/My/App/public"
    GIT_SHIP_AFTER_SHIP="cat Changes | mail -s "Changes for My::App" all@my-app.com"

## GIT\_SHIP\_AFTER\_BUILD

See ["GIT\_SHIP\_AFTER\_SHIP"](#git_ship_after_ship).

## GIT\_SHIP\_BEFORE\_BUILD

See ["GIT\_SHIP\_AFTER\_SHIP"](#git_ship_after_ship).

## GIT\_SHIP\_BEFORE\_SHIP

See ["GIT\_SHIP\_AFTER\_SHIP"](#git_ship_after_ship).

## GIT\_SHIP\_BUGTRACKER

URL to the bugtracker for this project.

## GIT\_SHIP\_CLASS

This class is used to build the object that runs all the actions on your
project. This is autodetected by looking at the structure and files in
your project. For now this value can be [App::git::ship](https://metacpan.org/pod/App%3A%3Agit%3A%3Aship) or
[App::git::ship::perl](https://metacpan.org/pod/App%3A%3Agit%3A%3Aship%3A%3Aperl), but any customization is allowed.

## GIT\_SHIP\_CONTRIBUTORS

Comma-separated list with `name <email>` of the contributors to this project.

## GIT\_SHIP\_DEBUG

Setting this variable will make "git ship" output more information.