ActivePivot
An easy way to store your Pivotal Tracker projects, stories, and epics
Installation
Add this line to your application's Gemfile:
gem 'active_pivot'
And then execute:
$ bundle
Or install it yourself as:
$ gem install active_pivot
Next, generate the migrations by running:
$ rails g active_pivot:migrations
Open up the "create_pivotal_stories" migration and change the line:
t.text[] :tags
to:
t.text :tags, array: true, default: []
Now, you can review the migrations and then run
$ rake db:migrate
and the requisite tables will be created.
Usage
Add your Pivotal Tracker API token to your secrets.yml:
tracker_api_token: <%= ENV["PIVOTAL_TRACKER_API_TOKEN"] %>
If you would like to use the import rake tasks, add this line to your project's Rakefile:
require 'active_pivot/import_tasks'
Now you can import your projects and stories using the following:
rake active_pivot:import:pivotal_initial
for all activity up to 3 years ago
rake active_pivot:import:pivotal_date[]
for all activity since a particular date.
Example: rake active_pivot:import:pivotal_date['August 12, 2015']
rake active_pivot:import:pivotal_update[]
for all activity since X minutes ago.
Example: rake active_pivot:import:pivotal_update[15]
Grabbing the start date of a Story requires sifting through its Activity, which can take a long time.
If you do not wish to record a Story's start date, use:
rake active_pivot:import:pivotal_update[15, false]
Note that if you're using zsh, you'll have to escape the brackets with a \
.
This gem will create the following models:
- ActivePivot::Activity
- ActivePivot::Epic
- ActivePivot::EpicStory
- ActivePivot::Project
- ActivePivot::Story
You can subclass these models in your project to customize behavior.
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake rspec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
License
The gem is available as open source under the terms of the MIT License.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
About Foraker Labs
Foraker Labs builds exciting web and mobile apps in Boulder, CO. Our work powers a wide variety of businesses with many different needs. We love open source software, and we're proud to contribute where we can. Interested to learn more? Contact us today.
This project is maintained by Foraker Labs. The names and logos of Foraker Labs are fully owned and copyright Foraker Design, LLC.