jolly-github-toolbelt 2.1.0

gt-assign-pr

A simple helper to assign a given PR to as set of users from the CLI.

gt-pr-doc-link

A simple helper to post a link to docs back to a PR when run in a Jenkins job.

Using Tokens

In order to provide for maximum flexibility, these tools are designed to work with GitHub Personal Access Tokens, which are needed for people using two-factor authentication or have access protected by SAML single sign on (SSO). GitHub provides instruction to obtain a token. The token can be provided to all commands either via the --token TOKEN flag, or by setting GH_TOKEN in your environment.

Custom GitHub URL

By default, this project works with https://github.com. In order to use an alternate URL, such as an enterprise install, you can provide the URL via an environment variable: GT_GH_URL.

gt-commit-msg

Ensure that a commit message conforms to some best practices:

1. Subject lines should not be longer than 50 characters

2. Wrap the body at 72 characters

3. Separate the subject from body with a blank line.

These are taken from A Note About Git Commit Messages.

gt-self-check

Can perform validations before making a commit. If an executable file named self-check.sh exists in the root of the repository and a Python, Ruby, or Gherkin file was changed, the checker is executed and the return status serves as a gate for the commit to occur. The check can be bypassed via git commit -n.

gt-prepare-commit-msg

Prepare a commit message by including an appropriate prefix, when possible, based on the branch name. If the branch name contains a JIRA ID, that is included in the prefix. If the branch name also contains either “FF” or “Spike”, that is appended to the prefix. If a branch name, without including a JIRA ID, contains “FF”, “Spike”, “Enhancement” or “Fix”, those phrases are set as the prefix. All searches are case-insensitive.