TeamMate - Homebrew Formula

You can use this script to quickly open and share pull request(s) for your project with your team. By default the command does a normal push to the server creating a pull request on 'master' branch using the last commit message as pull request tile and adding a label with the name of the branch. The default values can be overriden with a config file in the current folder. If in the configuration file the notification formatter and hook are defined, a post request is done to share the pull request info with the team.

Options:

-f : Force push to the server.

-t "new title" : Set the title used for the pull request and the notification.

-b "brA [brB]" : Set the destination branch(es). It uses space as separator.

-u : Skip the pull request(s) creation and fetch the first pull request url to send in the notification.

-s : Silence the notification.

-w : Add a 'WIP' label to the pull request(s) created

-h : Print the help

Note: This script is depending on 'hub', 'git' and 'curl'.

---

Intallation

Run the following script in your terminal to install the Formula locally

brew install https://github.com/FabriSilve/TeamMate/raw/master/teammate.rb

Run the following script in your terminal to upgrade the Formula locally

brew upgrade https://github.com/FabriSilve/TeamMate/raw/master/teammate.rb

---

Credentials for hub

TeamMate is using hub to comunicate with the GitHub api. To allow that without issues, you need to create an access token from your GitHub profile. All the steps are properly explained in the official guide.

The minimun permissions are all the one in the repo category.

After creating the access token, you need to create the hub's configuration file in ~/.config/hub with the following content

github.com:
- user: YOUR_GITHUB_USERNAME
  oauth_token: YOUR_AUTHENTICATION_TOKEN
  protocol: https

---

Configuration file

The config file has to be called .team and it need to be created in the folder where the script is called. The Defaults field overridable are:

• DEFAULT_BRANCH: A string of branches splitted by spaces.
• NOTIFICATION_HOOK: An url where the http POST request will be done for notification
• FORMATTER(): A method that receive author, message, pull request url and title. It has to set the variable NOTIFICATION with the JSON string to send in the request.

Example of .team file

DEFAULT_BRANCH="production"
NOTIFICATION_HOOK="https://hooks.slack.com/services/<TOKEN>"

FORMATTER(){
  author=${1:- }
  message=${2:- }
  url=${3:- }
  title=${4:- }
  NOTIFICATION="{\"username\":\"$author\",\"text\": \"$message <$url|$title>\"}"
}

Answers to common problems

Install Hub without apt

Error on Linux distros when trying to intall hub

Hub package is not pointing to the correct library with apt-install Thus you need to install Hub manually from the latest release Download the archive fitting your computer settings, extract it, and simply move your the hub file in your /usr/bin/ folder

---

---

Note for developer

Documentation links

https://docs.brew.sh/Formula-Cookbook

https://rubydoc.brew.sh/Formula

Create archive folder

tar -zcvf teammate-X.X.tar.gz src

Create sha256 hash

shasum -a 256 teammate-X.X.tar.gz | awk '{printf $1}' | pbcopy