https://github.com/odlp/inflight

Pre-populate commit messages with your Pivotal Tracker story ID
https://github.com/odlp/inflight

git-hooks pivotal-tracker pivotaltracker

Last synced: 22 days ago
JSON representation

Pre-populate commit messages with your Pivotal Tracker story ID

• Host: GitHub
• URL: https://github.com/odlp/inflight
• Owner: odlp
• License: mit
• Created: 2016-09-16T18:48:24.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-11-23T20:53:58.000Z (about 8 years ago)
• Last Synced: 2024-11-01T06:16:18.550Z (2 months ago)
• Topics: git-hooks, pivotal-tracker, pivotaltracker
• Language: Go
• Homepage:
• Size: 404 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Inflight

[![GitHub version](https://badge.fury.io/gh/odlp%2Finflight.svg)](https://badge.fury.io/gh/odlp%2Finflight)

[![Build Status](https://travis-ci.org/odlp/inflight.svg?branch=master)](https://travis-ci.org/odlp/inflight)

[![Coverage Status](https://coveralls.io/repos/github/odlp/inflight/badge.svg?branch=master)](https://coveralls.io/github/odlp/inflight?branch=master)

Inflight finds the ID of your currently started Pivotal Tracker story and adds it to your commit message. The story is located using the Git author's email.

Given you've started a story:

![Tracker commit example](assets/started-story-example.png)

When you're ready to commit:

```sh

git commit

```

The story ID is ready and waiting in your commit message:

```

# Please enter the commit message for your changes. Lines starting

# with '#' will be ignored, and an empty message aborts the commit.

# On branch master

# Changes to be committed:

#       new file:   <% some changes %>

#

[#89688392]

```

## Background

Pivotal Tracker & Github allow you to easily [link commits to your tracker stories](http://www.pivotaltracker.com/blog/guide-githubs-service-hook-tracker/). When you craft a commit message like this:

```

My words of wisdom

[#]

```

You'll see this commit linked in the activity of your story:

![Tracker commit example](assets/tracker-commit-example.png)

## Installation

1. [Download the latest release](https://github.com/odlp/inflight/releases) and place the binary on your path, e.g. `/usr/local/bin/inflight`

    Alternatively if you have Go installed, run:

    ```sh

    go get github.com/odlp/inflight

    ```

2. `cd` to the repo you'd like to configure.

3. Create a Git prepare commit message hook:

    ```sh

    touch .git/hooks/prepare-commit-msg

    ```

4. Edit the hook:

    ```sh

    #!/bin/bash

    export TRACKER_API_TOKEN=""

    export TRACKER_PROJECT_ID=""

    inflight -o "$1"

    ```

    > Your Pivotal Tracker API key is located in [Your Profile](https://www.pivotaltracker.com/profile). The project ID is visible in the address bar of your browser whilst viewing the project.

5. Make the hook executable:

    ```sh

    chmod +x .git/hooks/prepare-commit-msg

    ```

## Limitations

- The git author's email must match the email used for Pivotal Tracker.

- If you have more than one story started then the most recently updated story ID will be picked.

## Todo

- Add interactive git hook setup