It is just a bash script that runs on your git project. Give your email and get an API key and setup instructions. Nope, this is not to send any sort of email! I promise 😬

1. Setup

Once you have the API key, set the API key as an environment variable

export SHIPSHIT_API_KEY=<API_KEY>

Run the following command to setup a pre-push hook. It just takes last few commit messages, nothing more!

curl -o script.js https://www.shipshit.club/script.js && node script.js && rm script.js

Save a shipshit.json file in the root of your project with following details.

{
  "productName": "<Human readable product name>",
  "productKey": "<Alpha-numberic product key. Should be unique>",
  "productUrl": "<Product URL to show under product page>"
}

2. Update

Once setup is done, just run following command to give an update.

./.git/hooks/shipshit-update

Optionally, you can add it as an npm command to keep it handy and run npm run shipshit when you want to push an update!

"scripts": {
  ...,
  "shipshit": "node ./.git/hooks/shipshit-update"
}