https://github.com/spekulatius/gitpolicy
GitPolicy helps you to have guidelines around the usage of your git repository.
https://github.com/spekulatius/gitpolicy
Last synced: 8 months ago
JSON representation
GitPolicy helps you to have guidelines around the usage of your git repository.
- Host: GitHub
- URL: https://github.com/spekulatius/gitpolicy
- Owner: spekulatius
- License: bsd-3-clause
- Created: 2016-04-12T02:38:37.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-08-19T16:49:17.000Z (about 5 years ago)
- Last Synced: 2025-01-11T13:16:19.989Z (9 months ago)
- Language: PHP
- Homepage: https://releasecandidate.dev
- Size: 28.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: license.md
Awesome Lists containing this project
README
GitPolicy
=========
[](https://travis-ci.org/spekulatius/GitPolicy)
[](https://github.com/spekulatius/gitpolicy/releases)
[](https://packagist.org/packages/spekulatius/gitpolicy)
[](https://scrutinizer-ci.com/g/spekulatius/gitpolicy?branch=master)
[](https://packagist.org/packages/spekulatius/gitpolicy)
[](https://github.com/spekulatius/gitpolicy/blob/master/license.md)
GitPolicy helps you and your development team to follow [guidelines for the usage of git](https://github.com/spekulatius/gitpolicy). These guidelines can include several options, see features.
*Beta state: This package is still in development. Please be careful and patient if you decide to use it.*
Features
--------
This is the set of features to make your life easier:
* Define rules to achieve your desired git usage.
* Forbidden actions (e.g. create new tag, push to master),
* Expectations for names of git tags and branches are possible.
* Support for common conventions like "begins with a ticket numbers" and semantic tags are possible.
* Simple to configure and install: One command to do install and initial set up. Configuration over one file: .gitpolicy.yml
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.
The only direct requirement is PHP 5.4.37.
Note: During the installation [Composer](https://getcomposer.org) will be installed and used to manage the dependencies of GitPolicy.
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:
1. Change into your project directory.
2. Check and run the following command in your project folder:
```bash
# 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:
Configuration
-------------
All configuration is done in one file: .gitpolicy.yml
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.
Some .gitpolicy.yml examples:
* [default .gitpolicy.yml](https://github.com/spekulatius/gitpolicy/blob/master/templates/.gitpolicy.yml)
* [GitPolicy' own .gitpolicy.yml](https://github.com/spekulatius/gitpolicy/blob/master/.gitpolicy.yml)
More to come! If you want to share your .gitpolicy.yml as an example for a specific use case open a pull request ;)
[Roadmap and ideas](https://github.com/spekulatius/GitPolicy/issues)
-----------------
Please see the issue tracker for planned enhancements and the roadmap.
* 0.1.x:
* adding tests and bug fixes only
* 0.2.0:
* [Providing the ability to manage the default commit message by populating sensible default values](https://github.com/spekulatius/GitPolicy/issues/5)
* 0.3.0:
* [MAJOR: verification of commit messages](https://github.com/spekulatius/GitPolicy/issues/6)
License
-------
For information regarding the license see [license.md](https://github.com/spekulatius/GitPolicy/blob/master/license.md).