Rally Plugin
If you dislike logging into Rally...
You've committed your code, wrapped up the story, but now you have to log back into Rally (our organization makes us log in every three hours. THREE!) and update all the things.
OR you could install this plugin and just phrase your commit messages in a specific fashion and let the plugin handle the bookkeeping.
Configuration
Once you've installed the plugin through the normal channels (or by downloading the HPI file from the GitHub Releases page) you'll need to configure the plugin for your build.
First you'll want to add a credential to the Jenkins Credential store. Start by clicking on the "Credentials" link on the left side of the screen:
Add a credential and supply information like the following:
Rally has moved to a token-based authentication instead of the old "username and password" standard. To get a Rally API Key go to the Rally token page, click API Keys, and then "Create your own API key".
Now that your credential is configure you'll want to include the plugin in your build by clicking the following:
Once added, you'll be presented with the following:
- Rally API Key: Select the key you created at the beginning of the configuration section.
- Rally Workspace Name: Your workspace has a name. It should go here.
- Rally Repository Name: The name of the Repository object in Rally that you want the commits associated with. If you don't know what this is, just supply a generic value and check the checkbox for the "should create repository" configuration option.
- Create Repository if it doesn't already exist?: If you're supplying a new repository name and you haven't manually created it, this is a great box to check.
- Commit URI: Now we get to the fun stuff. This is a template of a URL that will be applied to all Changeset items (or "commits") that Rally adds. For example, if you're using GitHub, you may want your Changeset to link to
https://github.com/yourname/project-name/commit/[hash here]. The way to do that is supplyhttps://github.com/yourname/project-name/commit/${revision}. - File URI: This is the same template of a URL but will be applied to each individual file (Change) in the Changeset. For example, if you're using GitHub, you may want your Change to link to
https://github.com/yourname/project-name/blob/[hash-here]/src/filename.rb. The way to do that is to supplyhttps://github.com/yourname/project-name/blob/${revision}/${file}. - Update Changes: Select one from the dropdown.
- Proxy URI: This is a URI representing an HTTP proxy, if your build system is behind a proxy. You can add a username/password pair using this syntax:
http://username:password@myproxy.com:12345. - Capture Build Status in Rally? This option enables the collection of build statuses in Rally. Any story/defect references will automatically create a Build Definition for their associated project and you will start getting build status metrics in your Rally dashboard and reports.
Commit Syntax (optional)
Once you get the plugin configured you will likely need to change the way you author your commit statements.
The plugin can update your Task information based on the commit messages you supply. Here is a guide:
TA12345-- you can use this syntax to reference a specific Task under a Work Item#3-- you can also use this syntax. This is read as "Task #3 under the referenced Work Item"status:updates the Task's status to one of "In-Progress", "Defined", or "Completed". Setting a status to "Completed" will automatically set the 'to do' field to 0todo:updates the Task's "hours remaining" metricactuals:updates how long you've spent implementing a specific taskestimates:updates the estimate for a specific task
Each hourly metric is updated with whole numbers only.
Here are some example messages using the above metrics:
US12345: implements task #3 with status: completed; actuals: 5 hours, estimates: 6 hours (updated)
US12345 for task TA54321 with status: in progress; actuals: 3 hours, to do: 15
Contribution and License
If you want to contribute, please use the 'view project on GitHub' icon at the top of the page to see contribution information.
This project is distributed under the MIT license.