Provides additional functionality to gitflow-linter tool
Project description
About
gitflow_authors_linter is an official plugin for gitflow_linter command line tool. The plugin checks if currently a single author does not have too many open, ongoing feature branches. Having multiple open feature branches by a single author might be an indicator that something is wrong with the process. On top of that, merging all those branches might be complex in a near future.
Quick Start
Installation
You can install the linter from
- pip
pip install gitflow-linter-authors
- or the source code
git clone https://github.com/fighterpoul/gitflow_authors_linter.git
cd gitflow_authors_linter
git checkout 0.0.1
python setup.py install
HINT: Run gitflow-linter-plugins
to make sure that the plugin is available.
Usages
All you need to do is to:
- Add new item in your YAML file that configures how
gitflow-linter
should work:
rules:
no_multiple_open_features_per_author:
max_open_branches_per_author: 4 # mandatory
- Run
gitflow-linter
- it should automatically recognize that the plugin must be used to check the given rule.
Motivation
The plugin is there for the two reasons:
-
Demonstrate how you may extend
gitflow-linter
by using plugins -
Provide an additional step that verifies a given repository against authors
Therefore, it is supposed to be at the same time both useful and educative.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gitflow_authors_linter-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a6077ee15f8057b63fa65058d067b41467c9d462bf7699d8f1350687f544403 |
|
MD5 | d5660f3dd315fc1ae5fd96fd5e7835ba |
|
BLAKE2b-256 | e2e8c0386fc0fbf56c23ea2c4134d9eb9d578840de15ec2dcb2ebde2ef1109b4 |
Hashes for gitflow_authors_linter-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 901d46c9914e098fee26eeba34b72995d05b80ccc610e2de978433763411ab8d |
|
MD5 | 19b0230e416bae886d1f7fdeaeeda89a |
|
BLAKE2b-256 | 53ac2ebdcdc784b4cc00c7c0a644ed1991f38346b77d1828e4f19100c6914ed4 |