Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
An automated release documentation gen for pivotal tracker
Ruby
tag: v1.4.1

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
assets
lib
spec
templates
.gitignore
.rvmrc
Gemfile
Gemfile.lock
README
Rakefile
VERSION
pivotal_doc.gemspec

README

Automated release notes for apps hosted on pivotaltracker.com.  Allows release notes to be generated for any project on pivotaltracker.com by retrieving the latest "DONE" iteration for the specified project and displaying the accepted features, bugs, and chores.

UPDATE:
A new option has been added to the settings for each project (see below.)  You can now generate sprint committments by setting: 'current'=>true.  This will pull all stories regardless of whether or not they've been accepted from the current iteration.  

This is different than standard operating mode where only accepted stories from the last 'DONE' iteration are generated

Usage:
Either a file path (absolute) or a settings hash are supported for specifying your Pivotal Tracker credentials.

Supported formats: [:html, :text]
There is also a 'fancy' template for the html generator.  Supporting custom templates is planned soon.  Until then this is just a sample to get you started.  To make use of the fancy html you need to specify the template_name in your .yml file or settings hash (see sample below.)

PivotalDoc::Generator.generate(format, 'absolute_path_to_my_file')

PivotalDoc::Generator.generate(format, {
  'username'    => 'my_name',
  'password'    => 'my_password',
  'token'       => 'my_token' #Not needed if you specify username/password & vice-versa,
  'template_name'=>'fancy.html',
  'projects'    => {'github'=>
    {
      'id'        =>1, #This is the project_id from Pivotal Tracker
      'members'   =>['cyclone'],
      'current'   =>true/false #New setting to generate sprint committments
    }
  }
})

Also see the configs.yml sample file under spec/fixtures.

Note: The string keys are required (Using YAML to load file if specified.)
Note: It's recommended you define a story of type 'release' for each iteration to properly show the title,start/end dates, and points on the release notes.

Planned:
 Custom templates
 PDF
 Attachment support?


LASTLY, a big shout out to @jsmestad, author of the pivotal-tracker gem.  This gem provides a beautiful Active Record style DSL for interacting with Pivotal Tracker's API.
Something went wrong with that request. Please try again.