pivotal-integration 1.6.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (43) hide show
  1. checksums.yaml +15 -0
  2. data/LICENSE +202 -0
  3. data/NOTICE +2 -0
  4. data/README.md +331 -0
  5. data/bin/pivotal +81 -0
  6. data/lib/pivotal-integration/command/assign.rb +50 -0
  7. data/lib/pivotal-integration/command/base.rb +63 -0
  8. data/lib/pivotal-integration/command/command.rb +20 -0
  9. data/lib/pivotal-integration/command/comment.rb +31 -0
  10. data/lib/pivotal-integration/command/configuration.rb +129 -0
  11. data/lib/pivotal-integration/command/estimate.rb +53 -0
  12. data/lib/pivotal-integration/command/finish.rb +50 -0
  13. data/lib/pivotal-integration/command/info.rb +30 -0
  14. data/lib/pivotal-integration/command/label.rb +33 -0
  15. data/lib/pivotal-integration/command/mark.rb +44 -0
  16. data/lib/pivotal-integration/command/new.rb +52 -0
  17. data/lib/pivotal-integration/command/open.rb +31 -0
  18. data/lib/pivotal-integration/command/prepare-commit-msg.sh +26 -0
  19. data/lib/pivotal-integration/command/release.rb +54 -0
  20. data/lib/pivotal-integration/command/start.rb +82 -0
  21. data/lib/pivotal-integration/command/switch.rb +44 -0
  22. data/lib/pivotal-integration/util/git.rb +280 -0
  23. data/lib/pivotal-integration/util/label.rb +72 -0
  24. data/lib/pivotal-integration/util/shell.rb +36 -0
  25. data/lib/pivotal-integration/util/story.rb +170 -0
  26. data/lib/pivotal-integration/util/util.rb +20 -0
  27. data/lib/pivotal-integration/version-update/gradle.rb +64 -0
  28. data/lib/pivotal-integration/version-update/version_update.rb +20 -0
  29. data/lib/pivotal_integration.rb +18 -0
  30. data/spec/git-pivotal-tracker-integration/command/assign_spec.rb +55 -0
  31. data/spec/git-pivotal-tracker-integration/command/base_spec.rb +38 -0
  32. data/spec/git-pivotal-tracker-integration/command/configuration_spec.rb +119 -0
  33. data/spec/git-pivotal-tracker-integration/command/finish_spec.rb +45 -0
  34. data/spec/git-pivotal-tracker-integration/command/label_spec.rb +44 -0
  35. data/spec/git-pivotal-tracker-integration/command/mark_spec.rb +49 -0
  36. data/spec/git-pivotal-tracker-integration/command/release_spec.rb +57 -0
  37. data/spec/git-pivotal-tracker-integration/command/start_spec.rb +55 -0
  38. data/spec/git-pivotal-tracker-integration/util/git_spec.rb +235 -0
  39. data/spec/git-pivotal-tracker-integration/util/label_spec.rb +193 -0
  40. data/spec/git-pivotal-tracker-integration/util/shell_spec.rb +52 -0
  41. data/spec/git-pivotal-tracker-integration/util/story_spec.rb +158 -0
  42. data/spec/git-pivotal-tracker-integration/version-update/gradle_spec.rb +74 -0
  43. metadata +241 -0
checksums.yaml ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ !binary "U0hBMQ==":
3
+ metadata.gz: !binary |-
4
+ ODY3YjFhNGFjYjYxMjdhYmU1Zjc3Mzg0YjVhZTk0NjQwYjZhYWU0Zg==
5
+ data.tar.gz: !binary |-
6
+ Mjk2ODZhNjI5NGY1OTk4ZGI4NTcyNzYyZGM1ZmY2OWM2NjA4OGE3Yw==
7
+ SHA512:
8
+ metadata.gz: !binary |-
9
+ YzM2NTFmNDNmMjY1MjFmOTBjZmFhYWU0ODdlMjZjZjZmMmFmOTA1MmM2N2Vj
10
+ NTU5ZWMyZjA4NGIxMjRmYTJkMGNiZjhlMDAyMzRhZjQ3NDRiYzVmOGIwOTAy
11
+ MDM1ODU0ZTZjZjUwNTFhOWU1MjJmMGVkOGM4ZWExODM4NzVhYjQ=
12
+ data.tar.gz: !binary |-
13
+ ZTgwZTE5YjA5MjNjN2JhYmY4MDI2ZDI0OTdkZjE3MmJjNzE1YTg0ZjIwZmIy
14
+ NGM1ZjY3YzZhNmQ0YjQwYzAzMjFkYmM0MzFiYzg2MjNkZmNlOGI4N2JlMDc0
15
+ OGY5OGE1NjYzNWI0Mjg1NzAxYmU5YWE2YTIzOTdiZmFhN2MxNTg=
data/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/NOTICE ADDED
@@ -0,0 +1,2 @@
1
+ Git Pivotal Tracker Integration
2
+ Copyright 2013 the original author or authors.
data/README.md ADDED
@@ -0,0 +1,331 @@
1
+ # Git Pivotal Tracker Integration
2
+ [![Build Status](https://travis-ci.org/nebhale/git-pivotal-tracker-integration.png?branch=master)](https://travis-ci.org/nebhale/git-pivotal-tracker-integration)
3
+ [![Gem Version](https://badge.fury.io/rb/git-pivotal-tracker-integration.png)](http://badge.fury.io/rb/git-pivotal-tracker-integration)
4
+ [![Dependency Status](https://gemnasium.com/nebhale/git-pivotal-tracker-integration.png)](http://gemnasium.com/nebhale/git-pivotal-tracker-integration)
5
+ [![Code Climate](https://codeclimate.com/github/nebhale/git-pivotal-tracker-integration.png)](https://codeclimate.com/github/nebhale/git-pivotal-tracker-integration)
6
+
7
+
8
+ `pivotal-integration` provides a set of additional Git commands to help developers when working with [Pivotal Tracker][pivotal-tracker].
9
+
10
+ [pivotal-tracker]: http://www.pivotaltracker.com
11
+
12
+
13
+ ## Installation
14
+ `pivotal-integration` requires at least **Ruby 1.8.7** and **Git 1.8.2.1** in order to run. It is tested against Rubies _1.8.7_, _1.9.3_, and _2.0.0_. In order to install it, do the following:
15
+
16
+ ```plain
17
+ $ gem install pivotal-integration
18
+ ```
19
+
20
+
21
+ ## Usage
22
+ `pivotal-integration` is intended to be a very lightweight tool, meaning that it won't affect your day to day workflow very much. To be more specific, it is intended to automate branch creation and destruction as well as story state changes, but will not affect when you commit, when development branches are pushed to origin, etc. The typical workflow looks something like the following:
23
+
24
+ ```plain
25
+ $ pivotal start # Creates branch and starts story
26
+ $ git commit ...
27
+ $ git commit ... # Your existing development process
28
+ $ git commit ...
29
+ $ pivotal finish # Merges and destroys branch, pushes to origin, and finishes story
30
+ ```
31
+
32
+
33
+ ## Configuration
34
+
35
+ ### Git Client
36
+ In order to use `pivotal-integration`, two Git client configuration properties must be set. If these properties have not been set, you will be prompted for them and your Git configuration will be updated.
37
+
38
+ | Name | Description
39
+ | ---- | -----------
40
+ | `pivotal.api-token` | Your Pivotal Tracker API Token. This can be found in [your profile][profile] and should be set globally.
41
+ | `pivotal.project-id` | The Pivotal Tracker project id for the repository your are working in. This can be found in the project's URL and should be set.
42
+
43
+ [profile]: https://www.pivotaltracker.com/profile
44
+
45
+
46
+ ### Git Server
47
+ In order to take advantage of automatic issue completion, the [Pivotal Tracker Source Code Integration][integration] must be enabled. If you are using GitHub, this integration is easy to enable by navgating to your project's 'Service Hooks' settings and configuring it with the proper credentials.
48
+
49
+ [integration]: https://www.pivotaltracker.com/help/integrations?version=v3#scm
50
+
51
+
52
+ ## Commands
53
+
54
+ ### `pivotal start [new] [ type | story-id ]`
55
+ This command starts a story by creating a Git branch and changing the story's state to `started`. This command can be run in four ways. First it can be run specifying the id of the story that you want to start.
56
+
57
+ ```plain
58
+ $ pivotal start 12345678
59
+ ```
60
+
61
+ The second way to run the command is by specifying the type of story that you would like to start. In this case it will then offer you the first five stories (based on the backlog's order) of that type to choose from.
62
+
63
+ ```plain
64
+ $ pivotal start feature
65
+
66
+ 1. Lorem ipsum dolor sit amet, consectetur adipiscing elit
67
+ 2. Pellentesque sit amet ante eu tortor rutrum pharetra
68
+ 3. Ut at purus dolor, vel ultricies metus
69
+ 4. Duis egestas elit et leo ultrices non fringilla ante facilisis
70
+ 5. Ut ut nunc neque, quis auctor mauris
71
+ Choose story to start:
72
+ ```
73
+
74
+ The third way to run the command lets you create a new story straight from the command line. You can specify which type of story you'd like to create in the command, or you will be prompted to choose. The story name and estimate is also specified. The new story will then be assigned and started.
75
+
76
+ ```plain
77
+ $ pivotal start new
78
+ 1. Feature
79
+ 2. Bug
80
+ 3. Chore
81
+ 4. Release
82
+ What type of story do you want to create:
83
+ Provide a name for the new story:
84
+ Choose an estimation for this story [0, 1, 2, 3, enter for none]:
85
+ ```
86
+
87
+ Finally the command can be run without specifying anything. In this case, it will then offer the first five stories (based on the backlog's order) of any type to choose from.
88
+
89
+ ```plain
90
+ $ pivotal start
91
+
92
+ 1. FEATURE Donec convallis leo mi, dictum ornare sem
93
+ 2. CHORE Sed et magna lectus, sed auctor purus
94
+ 3. FEATURE In a nunc et enim tincidunt interdum vitae et risus
95
+ 4. FEATURE Fusce facilisis varius lorem, at tristique sem faucibus in
96
+ 5. BUG Donec iaculis ante neque, ut tempus augue
97
+ Choose story to start:
98
+ ```
99
+
100
+ Once a story has been selected by one of the methods, the command then prompts for the name of the branch to create.
101
+
102
+ ```plain
103
+ $ pivotal start 12345678
104
+ Title: Lorem ipsum dolor sit amet, consectetur adipiscing elitattributes
105
+ Description: Ut consequat sapien ut erat volutpat egestas. Integer venenatis lacinia facilisis.
106
+
107
+ Enter branch name (12345678-<branch-name>):
108
+ ```
109
+
110
+ The value entered here will be prepended with the story id such that the branch name is `<story-id>-<branch-name>`. This branch is then created and checked out.
111
+
112
+ If it doesn't exist already, a `prepare-commit-msg` commit hook is added to your repository. This commit hook augments the existing commit messsage pattern by appending the story id to the message automatically.
113
+
114
+ ```plain
115
+
116
+ [#12345678]
117
+ # Please enter the commit message for your changes. Lines starting
118
+ # with '#' will be ignored, and an empty message aborts the commit.
119
+ # On branch 12345678-lorem-ipsum
120
+ # Changes to be committed:
121
+ # (use "git reset HEAD <file>..." to unstage)
122
+ #
123
+ # new file: dolor.txt
124
+ #
125
+ ```
126
+
127
+ ### `pivotal finish [--no-complete] [--pull-request] [--no-merge]`
128
+ This command finishes a story. There are two workflows that can be used for finishing (pull requests and merging).
129
+
130
+ #### Pull Request Workflow
131
+ The pull request workflow can be accessed by specifying the `--pull-request` option, or by setting `pivotal.finish-mode` to `pull_request` in your git config. When using the PR workflow, when finishing a story, the branch will be pushed to the `origin` remote, and PR will be started (either launched in a web browser, or through the console using [hub](https://github.com/github/hub)). The behaviour can be specified by setting `pivotal.pull-request-editor` to `web` or `hub` in your git config.
132
+
133
+ In both cases, the story will also be updated to mark its status as Finished.
134
+
135
+ ```plain
136
+ $ pivotal finish --pull-request
137
+ Pushing to origin... OK
138
+ Changing state to finished
139
+ ```
140
+
141
+ #### Merge Workflow
142
+ This command finishes a story by merging and cleaning up its branch and then pushing the changes to a remote server. This command can be run in two ways. First it can be run without the `--no-complete` option.
143
+
144
+ ```plain
145
+ $ pivotal finish
146
+ Checking for trivial merge from 12345678-lorem-ipsum to master... OK
147
+ Merging 12345678-lorem-ipsum to master... OK
148
+ Deleting 12345678-lorem-ipsum... OK
149
+ Pushing to origin... OK
150
+ ```
151
+
152
+ The command checks that it will be able to do a trivial merge from the development branch to the target branch before it does anything. The check has the following constraints
153
+
154
+ 1. The local repository must be up to date with the remote repository (e.g. `origin`)
155
+ 2. The local merge target branch (e.g. `master`) must be up to date with the remote merge target branch (e.g. `origin/master`)
156
+ 3. The common ancestor (i.e. the branch point) of the development branch (e.g. `12345678-lorem-ipsum`) must be tip of the local merge target branch (e.g. `master`)
157
+
158
+ If all of these conditions are met, the development branch will be merged into the target branch with a message of:
159
+
160
+ ```plain
161
+ Merge 12345678-lorem-ipsum to master
162
+
163
+ [Completes #12345678]
164
+ ```
165
+
166
+ The second way is with the `--no-complete` option specified. In this case `finish` performs the same actions except the `Completes`... statement in the commit message will be supressed.
167
+
168
+ ```plain
169
+ Merge 12345678-lorem-ipsum to master
170
+
171
+ [#12345678]
172
+ ```
173
+
174
+ After merging, the development branch is deleted and the changes are pushed to the remote repository.
175
+
176
+ ### `pivotal release [story-id]`
177
+ This command creates a release for a story. It does this by updating the version string in the project and creating a tag. This command can be run in two ways. First it can be run specifying the release that you want to create.
178
+
179
+ ```plain
180
+ $ pivotal release 12345678
181
+ ```
182
+ The other way the command can be run without specifying anything. In this case, it will select the first release story (based on the backlog's order).
183
+
184
+ ```plain
185
+ $ pivotal release
186
+ Title: Lorem ipsum dolor sit amet, consectetur adipiscing elitattributes
187
+ ```
188
+
189
+ Once a story has been selected by one of the two methods, the command then prompts for the release version and next development version.
190
+
191
+ ```plain
192
+ $ pivotal release
193
+ Title: Lorem ipsum dolor sit amet, consectetur adipiscing elitattributes
194
+
195
+ Enter release version (current: 1.0.0.BUILD-SNAPSHOT): 1.0.0.M1
196
+ Enter next development version (current: 1.0.0.BUILD-SNAPSHOT): 1.1.0.BUILD-SNAPSHOT
197
+ Creating tag v1.0.0.M1... OK
198
+ Pushing to origin... OK
199
+ ```
200
+
201
+ Once these have been entered, the version string for the current project is updated to the release version and a tag is created. Then the version string for the current project is updated to the next development version and a new commit along the original branch is created. Finally the tag and changes are pushed to the remote sever.
202
+
203
+ Version update is currently supported for the following kinds of projects. If you do not see a project type that you would like supported, please open an issue or submit a pull request.
204
+
205
+ ### `pivotal new [type] [name]`
206
+ This command lets you create a new story in Pivotal Tracker directly from the command line. The story type and name can be provided as command line options or from prompts. Creating a story in this way adds it to the Icebox, and does not assign or start the story (contrasted to `pivotal start new`).
207
+
208
+ ```plain
209
+ $ pivotal new feature "Create a blog"
210
+ ```
211
+
212
+ ```plain
213
+ pivotal new
214
+ 1. Feature
215
+ 2. Bug
216
+ 3. Chore
217
+ 4. Release
218
+ What type of story do you want to create:
219
+ Provide a name for the new story:
220
+ ```
221
+
222
+ ### `pivotal info`
223
+ This command gives you an output of info from the current story (including description, notes, etc.).
224
+
225
+ ```plain
226
+ $ pivotal info
227
+ ID: 123456
228
+ Project: My Project
229
+ Title: Create a blog
230
+ Type: Feature
231
+ State: Started
232
+ Estimate: 3
233
+ Note 1: How many posts do we want to limit the blog to?
234
+ ```
235
+
236
+ ### `pivotal estimate [points]`
237
+ This command lets you set or change the estimate for the current story. This command can be run in two ways. First it can be run by specifying the score you want to assign.
238
+
239
+ ```plain
240
+ $ pivotal estimate 3
241
+ ```
242
+
243
+ The second way is to run the command with specifying anything. In this case, the current estimate will be shown, as well as all the possible values (as set up for the project in Pivotal Tracker). In this mode, you can also choose to remove the estimate by leaving the score prompt blank.
244
+
245
+ ```plain
246
+ $ pivotal estimate
247
+ Story is currently estimated 3.
248
+ Choose an estimation for this story [0, 1, 2, 3, enter for none]:
249
+ ```
250
+
251
+ ### `pivotal switch ID`
252
+ This command lets you switch the active Pivotal Tracker story to a different one.
253
+
254
+ ```plain
255
+ $ pivotal switch 12345678
256
+ ```
257
+
258
+ ### `pivotal assign [username]`
259
+ This command assigns current story to another member of Pivotal Tracker project. This command can be run in two ways. First it can be run with specific username of project's member. If username consists of more than one world use braces as in example.
260
+
261
+ ```plain
262
+ $ pivotal assign 'Mark Twain'
263
+ ```
264
+
265
+ The other way the command can be run without specifying anything. In this case, you will be able to choose from all project members.
266
+
267
+ ```plain
268
+ $ pivotal assign
269
+
270
+ 1. Mark Twain
271
+ 2. Edgar Alan Poe
272
+ Choose an user from above list:
273
+ ```
274
+
275
+ ### `pivotal label [mode] label1 ... labeln`
276
+ This command manages story labels, there are four modes you can use:
277
+ * add - appends new labels to story
278
+ * once - appends new labels to story and removes it's occurences from every other story in project
279
+ * remove - removes labels from story
280
+ * list - lists labels attached to current story
281
+
282
+ ```plain
283
+ $ pivotal label list
284
+ ```
285
+
286
+ You have to specify mode and at least on label if you are using add, once or remove modes.
287
+
288
+ ```plain
289
+ $ pivotal label add on_qa
290
+ ```
291
+
292
+ ### `pivotal mark [state]`
293
+ This command marks current story with specified state. You can add desired state as follows:
294
+
295
+ ```plain
296
+ $ pivotal mark finished
297
+ ```
298
+
299
+ The other way the command can be run without specifying anything. In this case, you will be able to choose from all possible states.
300
+
301
+ ```plain
302
+ $ pivotal mark
303
+
304
+ 1. unstarted
305
+ 2. started
306
+ 3. finished
307
+ 4. delivered
308
+ 5. rejected
309
+ 6. accepted
310
+ Choose story state from above list:
311
+ ```
312
+
313
+ ### `pivotal comment TEXT`
314
+ This command allows you to add a comment (note) to the current story. The comment text must be given with the command.
315
+
316
+ ```plain
317
+ $ pivotal comment "Good idea!"
318
+ ```
319
+
320
+ ### `pivotal open [project]`
321
+ This command lets you open the current story or project in a web browser (this functionality is provided by [launchy](https://github.com/copiousfreetime/launchy) and may not work in all environments). There are two ways the command can be run in. First, if you want to open the current story directly.
322
+
323
+ ```plain
324
+ $ pivotal open
325
+ ```
326
+
327
+ Second, if you want to open the entire project
328
+
329
+ ```plain
330
+ $ pivotal open project
331
+ ```
data/bin/pivotal ADDED
@@ -0,0 +1,81 @@
1
+ #!/usr/bin/env ruby -U
2
+ # Git Pivotal Tracker Integration
3
+ # Copyright (c) 2013 the original author or authors.
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ require 'active_support'
18
+ require 'active_support/core_ext/string'
19
+
20
+ Dir.glob(File.expand_path("../../lib/pivotal-integration/command/*.rb", __FILE__)).each do |file|
21
+ next if %w(base.rb command.rb configuration.rb).include?(File.basename(file))
22
+ require file
23
+ end
24
+
25
+ COMMANDS = ObjectSpace.each_object(Class).select { |klass| klass < PivotalIntegration::Command::Base }
26
+ COMMAND_NAMES = COMMANDS.map{|c|c.name.demodulize.downcase}
27
+ MAX_COMMAND_LEN = COMMAND_NAMES.map(&:length).max
28
+
29
+ def print_command_help(commands)
30
+ commands.each do |command|
31
+ puts " %-#{MAX_COMMAND_LEN}s %s" % [command.name.demodulize.downcase, command.description]
32
+ end
33
+ end
34
+
35
+ def show_help
36
+ puts "Usage: git pivotal [--help] <command> [<args>]"
37
+ puts
38
+
39
+ main_commands = COMMANDS.select{ |c| %w(start finish new).include? c.name.demodulize.downcase }
40
+ secondary_commands = COMMANDS - main_commands
41
+
42
+ puts "Main Commands"
43
+ print_command_help(main_commands.sort_by{ |c| %w(new start finish).index(c.name.demodulize.downcase) })
44
+
45
+ puts
46
+ puts "Secondary Commands:"
47
+ print_command_help(secondary_commands.sort_by(&:name))
48
+ end
49
+
50
+ begin
51
+ options = {}
52
+ optparse = OptionParser.new do |opts|
53
+ opts.on('-h', '--help') do
54
+ show_help
55
+ exit
56
+ end
57
+
58
+ opts.on('-S', '--story ID') do |id|
59
+ options[:story_id] = id
60
+ end
61
+ end
62
+ optparse.parse!
63
+
64
+ if COMMAND_NAMES.include?(ARGV.first.try(:downcase))
65
+ command = ARGV.shift
66
+ command_class = PivotalIntegration::Command.const_get(command.classify)
67
+ command_class.new(options).run(*ARGV)
68
+
69
+ elsif ARGV.empty?
70
+ show_help
71
+
72
+ else
73
+ abort "Invalid command #{ARGV.first}."
74
+ end
75
+
76
+ rescue Interrupt
77
+ puts
78
+ puts "Operation cancelled."
79
+ exit
80
+ end
81
+ #
@@ -0,0 +1,50 @@
1
+ # Git Pivotal Tracker Integration
2
+ # Copyright (c) 2013 the original author or authors.
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+
16
+ require_relative 'base'
17
+ require 'pivotal-tracker'
18
+
19
+ # The class that encapsulates assigning current Pivotal Tracker Story to a user
20
+ class PivotalIntegration::Command::Assign < PivotalIntegration::Command::Base
21
+ desc "Assign the current story to a user"
22
+
23
+ # Assigns story to user.
24
+ # @return [void]
25
+ def run(*arguments)
26
+ username = arguments.first
27
+
28
+ if username.nil? or !memberships.include?(username)
29
+ username = choose_user
30
+ end
31
+
32
+ PivotalIntegration::Util::Story.assign(story, username)
33
+ end
34
+
35
+ private
36
+
37
+ def choose_user
38
+ choose do |menu|
39
+ menu.prompt = 'Choose an user from above list: '
40
+
41
+ memberships.each do |membership|
42
+ menu.choice(membership)
43
+ end
44
+ end
45
+ end
46
+
47
+ def memberships
48
+ @project.memberships.all.map(&:name)
49
+ end
50
+ end