Skip to main content

A collection of tools around Git and GitHub to make developers' lives easier.

Project description

GitHub Tools

A collection of tools around Git and GitHub to make developers’ lives easier.

gt-assign-pr

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

Usage

This tool requires the use of a token (see Using Tokens). By simply providing a owner, repository, pr_number and as many users as desired, you can assign the given PR to those users. By default, currently assigned users are kept, but they can be removed using the --clear-current flag.

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.

pre-commit hooks

This repository also provides three hooks, documented below, that can be installed by hand or via pre-commit:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jolly_github_toolbelt-2.1.0.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

jolly_github_toolbelt-2.1.0-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file jolly_github_toolbelt-2.1.0.tar.gz.

File metadata

  • Download URL: jolly_github_toolbelt-2.1.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.16 CPython/3.6.7 Darwin/18.6.0

File hashes

Hashes for jolly_github_toolbelt-2.1.0.tar.gz
Algorithm Hash digest
SHA256 507d976df91da159071c56d59d3e3237f9e5bf3e3cc42f918e8e1c727cdd0030
MD5 22eadaf159c3b5a160ab7d4823bb5ad2
BLAKE2b-256 1de515be43b22ce4dd8ec10a4a9efee0356eb042cc3a4bfa64254645dd569f90

See more details on using hashes here.

File details

Details for the file jolly_github_toolbelt-2.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jolly_github_toolbelt-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9467157870f4bec1d52887bcf8b9cb3885f02fcbbe8a2f8b798eb67c4f019d9b
MD5 575ebb82df60d6c21943a15d18affa97
BLAKE2b-256 277dcb10a12db16cfd74a7621ee275f8b05c34a3a110e6bf5391104f4c6a4b34

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page