- ENVIRONMENT VARIABLES
- SEE ALSO
- COPYRIGHT AND LICENSE
App::git::ship - Git command for shipping your project
See "SYNOPSIS" in App::git::ship::perl 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'
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.
Currently, only App::git::ship::perl is supported.
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", but without the "GIT_SHIP_" prefix.
Note however that all environment variables are optional, and in many cases App::git::ship will simply do the right thing, without any configuration.
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" firstname.lastname@example.org"
URL to the bugtracker for this project.
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 or App::git::ship::perl, but any customization is allowed.
Comma-separated list with
name <email> of the contributors to this project.
Setting this variable will make "git ship" output more information.
URL to the home page for this project.
The name of the license to use. Defaults to "artistic_2".
Setting this variable will make "git ship" output less information.
$ship->abort($str); $ship->abort($format, @args);
Will abort the application run with an error message.
This method builds the project. The default behavior is to "abort". Needs to be overridden in the subclass.
$bool = $class->can_handle_project($file);
This method is called by "detect" in App::git::ship and should return boolean true if this module can handle the given git project.
This is a class method which gets a file as input to detect or have to auto-detect from current working directory.
All the modules in the App::git::ship namespace will be loaded and asked if they can handle the given project you are in or trying to create.
$hash_ref = $ship->config; $str = $ship->config($name); $self = $ship->config($name => $value);
Holds the configuration from end user. The config is by default read from
.ship.conf in the root of your project if such a file exists. "ENVIRONMENT VARIABLES" can also be used to build the config, but the settings in
.ship.conf has priority.
$class = $ship->detect; $class = $ship->detect($file);
Will detect the sub class in the App::git::ship::perl namespace which can be used to handle a project. Will first check "GIT_SHIP_CLASS" or call "can_handle_project" on all the classes in the App::git::ship::perl namespace if not.
$str = $ship->dump($any);
$any into a perl data structure, using Data::Dumper.
$ship = App::git::ship->new(\%attributes);
Creates a new instance of
Used to render a template by the name
$file to a
$file. The template needs to be defined in the
DATA section of the current class or one of the super classes.
Used to run a hook before or after an event. The hook is a command which needs to be defined in "config". See also "GIT_SHIP_AFTER_BUILD", "GIT_SHIP_AFTER_SHIP", "GIT_SHIP_BEFORE_BUILD" and "GIT_SHIP_BEFORE_SHIP".
This method ships the project to some online repository. The default behavior is to make a new tag and push it to "origin". Push occurs only if origin is defined in git.
This method is called when initializing the project. The default behavior is to populate "config" with default data:
Same as perl's
system(), but provides error handling and logging.
This project can probably get you to the moon.
This looks really nice for shipping your project. It has the same idea as this distribution: Guess as much as possible.
One magical tool for doing it all in one bang.
Copyright (C) 2014-2018, Jan Henning Thorsen
This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.
Jan Henning Thorsen -
Rolf Stöckli -
Shoichi Kaji -