/pivotal-friendly-numbers

Ensures friendly issues numbers are stored on issue descriptions.

Primary LanguageJavaScript

Overview

Setup your project to have auto incrementing short ticket numbers on Pivotal Tracker. example

Setup

Requires a postgres database. You can run the lib/createdb.sql to set it up with the required table. Alternatively you can mod the code to remove the dependency and use a different strategy to generate the ticket numbers.

yarn install
npm install

Grab your pivotal token here

NOTE: Ensure you are using a bot account, as if you use your main account it won't update the tickets when you edit them.


Grab your project id here


Grab your service account id here

You can use either your own account but it's recommend to setup a "bot" user.

Then bring up dev tools to find the account id.


Deploy your website

You'll need an AWS account, after which you can then run the following to deploy via serverless. Be sure to replace the env variables with the data you retrieved above.

PIVOTAL_TOKEN=xxxx \
PROJECT_ID=xxxx \
SERVICE_ACCOUNT_ID=xxxx \
TICKET_PREFIX=PAD- \
PGHOST=xxxx \
PGPASSWORD=xxxx \
PGUSER=xxxx \
PGDATABASE=xxxx \
npx serverless deploy

Add the webhook

Navigate to the webhooks section on Pivotal Tracker and enter the URL serverless let's you know about.

Develop

To run locally, same steps as above but run

PIVOTAL_TOKEN=xxxx \
PROJECT_ID=xxxx \
SERVICE_ACCOUNT_ID=xxxx \
TICKET_PREFIX=PAD- \
PGHOST=xxxx \
PGPASSWORD=xxxx \
PGUSER=xxxx \
PGDATABASE=xxxx \
npx serverless offline start