Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Gem for slurping plain text stories into Pivotal Tracker

tree: 16c94a7c85

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.rdoc

slurper

Slurper allows you to quickly compose your stories in a text file and import them into Pivotal Tracker.

Works great with slurper.vim! (github.com/alowe/vim-slurper)

Note on Patches/Pull Requests

  • Fork the project.

  • Make your feature addition or bug fix.

  • Add tests for it. This is important so I don't break it in a future version unintentionally.

  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

  • Send me a pull request.

Setup

$gem install slurper

Config

Slurper requires a slurper_config.yml file in your working directory. This file contains your Tracker API and story requestor information.

Example

project_id: 1234
token: 123abc123abc123abc
requested_by: Jane Stakeholder
ssl: true

The project_id tells tracker which project to add your stories to. It can be found on the project settings or the url for the project.

The token can be found on your personal profile page in Pivotal Tracker.

The requested_by field should be the name of your project stakeholder exactly as it appears in tracker.

The ssl field should be set to true if you've enabled “Use HTTPS” in Pivotal Tracker. SSL is being verified by peer using the cacert.pem from (curl.haxx.se/ca)

Usage

Create a stories.slurper file and compose your stories in the slurper story format. In your working directory use the slurp command to import your stories from the stories.slurper file into Pivotal Tracker. Slurper looks for a stories.slurper file in your current directory by default, however, you can provide an alternate story source file if necessary.

Default

$slurp ~/stories.slurper

Also valid

$slurp ~/special_stories.slurper

Or even

$slurp ~/mystories.txt

Example stories.slurper

==   story_type:
  chore
name:
  Set Up Staging Environment
description:
  Set up and configure staging environment for approval of stories

labels:

==   story_type:
  feature
name:
  Campaign Manager Does Something
description:
  In order to get some value
  As a campaign manager
  I want to do something

  - can do something

labels:
  campaign managers
==   story_type:
  release
name:
  Big Release
description:
  This release marks a lot of awesome functionality

labels:

==   story_type:
  bug
name:
  I did something and nothing happened
description:
  When I do something, another thing is supposed to happen but I see an error screen instead.

labels:

Note: the story source file is whitespace-sensitive. Be sure the value for each key phrase is indented with two spaces beneath each key phrase. Also, start each story with a double-equals on its own line.

Your best bet is to leverage slurper.vim and benefit from its auto-indenting goodness.

Credit - Wes Gibbs (wgibbs.github.com) thought of and wrote slurper as a ruby script. It was later packaged and released as a gem by his fellow Rocketeers after using it and finding it extremely handy.

Something went wrong with that request. Please try again.