GitPolicy

, _(*1)

GitPolicy helps you and your development team to follow guidelines for the usage of git. These guidelines can include several options, see features., _(*2)

Beta state: This package is still in development. Please be careful and patient if you decide to use it., _(*3)

Features

This is the set of features to make your life easier:, _(*4)

Define rules to achieve your desired git usage., _(*5)
- Forbidden actions (e.g. create new tag, push to master),, _(*6)
- Expectations for names of git tags and branches are possible., _(*7)
- Support for common conventions like "begins with a ticket numbers" and semantic tags are possible., _(*8)
Simple to configure and install: One command to do install and initial set up. Configuration over one file: .gitpolicy.yml, _(*9)

Requirements

This has been developed on a Debian destribution with Linux in mind. It should work on similar platforms. Mac OS: Maybe. Windows? No idea., _(*10)

The only direct requirement is PHP 5.4.37., _(*11)

Note: During the installation Composer will be installed and used to manage the dependencies of GitPolicy., _(*12)

Installation

The installation and set up are combined into one single command for you to run. It will take all of the steps to install, configurature, re-initalize or update GitPolicy. This is how it works:, _(*13)

Change into your project directory., _(*14)

Check and run the following command in your project folder:, _(*15)

# install or update composer - we need this to manage the dependencies
curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer;

# install the package as a global dependency and symlink it.
composer global require spekulatius/gitpolicy;
sudo ln -s ~/.composer/vendor/spekulatius/gitpolicy/gitpolicy /usr/local/bin/gitpolicy;

# run the initial steps, this configures the git hook as well as copies the initial config file into your project.
gitpolicy init;

# commit the change
git add composer.json composer.lock .gitpolicy.yml;
git commit -m 'CHORE: Adding gitpolicy :sunny:'

Done :sunglasses:, _(*16)

Configuration

All configuration is done in one file: .gitpolicy.yml, _(*17)

With the initialization, an example is copied into your project :) All possible (sensible and non-sense) combinations of options have been listed. Please delete parts which aren't required for your project. By default there shouldn't be a strong policy in place., _(*18)

Some .gitpolicy.yml examples:, _(*19)

More to come! If you want to share your .gitpolicy.yml as an example for a specific use case open a pull request ;), _(*20)