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-authors-linter
- or the source code
git clone https://github.com/fighterpoul/gitflow_authors_linter.git
cd gitflow_authors_linter
git checkout 0.0.2
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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9287e0949bf905463a5a5dcf470597fb9ce7942d9633371f7601dff5dbdb3b41 |
|
MD5 | 2f81e20ce3fd164e49ced902766b470e |
|
BLAKE2b-256 | 5890ae05a856b225f75775c76c0b1ff07ba6b509d2f0b58bf1ce34db6ce8944c |
Hashes for gitflow_authors_linter-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 462a4ad9a6bf083528abdb7055d334da2ac35413eae92aee2dd1374e4f60e98c |
|
MD5 | 3cea1b679797d69344a796b24bfc94f5 |
|
BLAKE2b-256 | 8b4e8823a8e97cb5f201af503ab43524044fc52bd2b8bb019232c3359fb043c0 |