Skip to content

jeancfo/repo-tools

 
 

Repository files navigation

This repo contains a number of tools for working with GitHub repositories. One of them is author-check.

author-check

A commandline utility for checking for consistency between committers, people who have signed a contributor agreement and people in the AUTHORS file.

./author_check.py <owner>/<repo>
audits the given repo

./author_check.py <owner>/<repo> <pull-request-number>
audits the given pull request

./author_check.py <user>
status of given user

./author_check.py
audits all repos in repos.yaml

Installation

You'll need to have virtualenv installed already. Then run:

git clone https://github.com/edx/author-check.git
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt

You'll also need to grab a personal access token from Github (go to https://github.com/settings/applications to create one) and create an auth.yaml file of the form:

user: "<your github username>"
token: "<your personal access token>"

people.yaml contains the mapping between Github username and the canonical entry for AUTHORS files. It also has information about whether the person has signed a contributor agreement or is covered by the institution they work for.

Feedback

Please send any feedback to jtauber@edx.org.

About

Tools for repo maintenance, etc.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published