Integration tips to reduce / optimize Github-PivotalTracker workflow

github-pivotal-tracker-integration.txt

/**
This gist assists in automating 2 steps of Pivotal Tracker (PV)
Workflow / life cycle for a ticket
1. [PV] Start ticket
2. [Github] Commit, Push and Create Pull Request
3. [PV] Finish ticket
4. [Github] Merge Pull Request
5. [PV] Deliver ticket

The purpose of this integration, as of now, is to eliminate step [1.] and [3.]

Updated workflow / life cycle
1. [Github] Commit with message to 'start' or 'finish' PV ticket (obviously, works only on Github PUSH, not only commit - formats explained below)
2. [Github] Merge Pull Request
3. [PV] Deliver ticket
**/


# Commit message format for PV `Features` or `Chores`
Including the below messages in the GitHub Commit will move the feature to 'started' state, if not already started
This means that the Pivotal Tracker ticket will now show the 'finish' button)
    `[#123456] some message` - This will put the task to started, if not already started
    
One way to do this easily on start of a branch is as follows
    `git checkout -b feature/123456/some-branch`
    `git commit -m "[#123456] Empty commit" --allow-empty`
    `git push`

# Commit message format for `Features`
Including the below messages in the GitHub Commit will move the feature to 'finished' state (the Pivotal Tracker ticket will now show the 'deliver' button)

    `[fixes #123456]` or `[#1234 fixes]`
    `[fixed #123456]` or `[#123456 fixed]`
    `[completed #123456]` or `[#123456 completed]`
    `[Fix #123456]` or `[#123456 Fix]`
    `[FIXES #123456]` or `[#123456 FIXES]`


Sample commit message
    `[fixes #123456] I can type any message I want`


# Integration for `Chores`
* Chores move to 'accepted' state directly, as they do not go through the workflow of 'finish' -> 'deliver' -> 'accept'
    [Same commit message format as above]


/**
Assumption: Github webhook is already created for Pivotal Tracker
**/