torque 0.3.0 → 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +12 -8
  3. data/VERSION +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 14355f09eb1d9a65345ed81c053ceb353f3990e3
4
- data.tar.gz: 7f6e191c2a67318615be764f1f99de4a959abb67
3
+ metadata.gz: 4bbf96a5e564ef44f742123c47a9509abe4c18ea
4
+ data.tar.gz: e20c283836eee7bf65a5b3bac666a40e389ecd96
5
5
  SHA512:
6
- metadata.gz: 7641002a1af10500ca46689627c7de5aac7c8d78f8423e17c9506c949ea5d29e653845fb7f2c6fbb3bfafab6111ac8ed807339302bf9b4a412cdbb1699bfc882
7
- data.tar.gz: ba240db9ca4829a3f92d90900032b9ab8b93b09118b2a21529253da23cf84d8eae03b40964a97874197976d73752308d903b796ab3aaaea9ef28f037705f67af
6
+ metadata.gz: df9a49f19e231ba96215dbfc1082e790502c82c0d7e3fd06410f1ca8f96e0f568c6c76e64a79fe9cbe96081715a5dbb332303033f394cfe3177756eda6cb1236
7
+ data.tar.gz: 490ca79fbe959b5f6232bf9a9825c791213ac1f51c60a72bcb69f779fd1d4644f50d054b16c97eec314e20765f71b3a951cf0c5f6d25bedb57145fae3fe3945e
data/README.md CHANGED
@@ -25,7 +25,7 @@ Current Features
25
25
  * Automatically compiles all Pivotal Tracker stories accepted between the current date and the last time Torque was run
26
26
  * Store a record of each document on generation
27
27
  * Compile stories accepted within a custom date range
28
- * Filtering stories by label, owner or story type
28
+ * Filtering stories by label, owner and/or story type
29
29
  * Generate notes for specific number of completed project iterations
30
30
  * Configuration script that automatically sets up a directory to use Torque
31
31
  * Display all of your current Pivotal Tracker projects and easily switch between them
@@ -34,7 +34,7 @@ Current Features
34
34
  Note on Confidentiality
35
35
  -----------------------
36
36
 
37
- During usage, Torque will request some confidential information -- namely, your Pivotal Tracker API token and your email username/password. This information is stored in a local config file on your computer and is only used to access (respectively) Pivotal Tracker and your email server. It is never collected, sent to a 3rd party, or used for any other purpose.
37
+ During usage, Torque will request some confidential information: Namely, your Pivotal Tracker API token and your email username/password. This information is stored in a local config file on your computer and is only used to access, respectively, Pivotal Tracker and your email server. It is never collected or used for any other purpose.
38
38
 
39
39
  Torque stores this data in a file called '.torqueinfo.yaml': Do not commit this file to your version control system!
40
40
 
@@ -81,17 +81,21 @@ To compile release notes for stories within a custom date range:
81
81
 
82
82
  If [from] is set, [to] will default to today. If [to] is set, [from] will default to 1/1/1900.
83
83
 
84
- To filter your results by story label, owner or type:
84
+ To generate notes for X number of completed iterations of your project:
85
85
 
86
- # torque --label list,of,labels --owner "list, of, owners" --type "list,of,story types"
86
+ # torque --iterations X
87
87
 
88
- Note: The Pivotal Tracker API currently only supports "AND" searches for these fields. A search for multiple labels, for example, will turn up only the stories that match every label. ("OR" searches may or may not be added with the release of the PT API v5, which should arrive soon.)
88
+ To filter your results by story label, owner or type:
89
89
 
90
- To generate notes for X number of completed iterations of your project:
90
+ # torque --label list+of,labels
91
+ # torque --owner "list + of , owners"
92
+ # torque --type "list, of + story types"
91
93
 
92
- # torque --iterations X
94
+ When using filters, "," is used to signify OR, "+" is used to signify AND, and "+" has a higher precedence than ",". For example, "ios + android, ios + web" becomes
95
+
96
+ ("ios" AND "android") OR ("ios" AND "web")
93
97
 
94
- Note that a run with iterations currently disables filters, and it is incompatible with custom date ranges.
98
+ Additionally, the "owner" filter will try to match against first/middle/last names as well as full names. For instance, '--owner Lee' will match stories owned by "Lee Grant", "Jake Lee", or "Kate Lee Swanson".
95
99
 
96
100
  To email the release notes from a personal email to Torque's mailing list:
97
101
 
data/VERSION CHANGED
@@ -1,3 +1,3 @@
1
1
  major:0
2
2
  minor:3
3
- patch:0
3
+ patch:1
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: torque
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.3.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Nico Adams, Scrimmage