git_breeze 1.1.7 → 1.1.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -1
- data/README.md +16 -16
- data/lib/git_breeze/hook.rb +1 -1
- data/lib/git_breeze/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 707fb4d0fd1c859d08cb7fd637003e533899df3a
|
4
|
+
data.tar.gz: 26917ad5a498e311e7d6e0b945212f8a579b5cf6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e20902ca75b8781cee559b9cdf7edf43c43e83bf2e223b8c9f9c3234f6f0ae6370755550b0dc2f3933fe41e0dce14410af75e0275194bafa7c3baccd094d80c0
|
7
|
+
data.tar.gz: 7adf412aabff06a5853a69dd9a44a4640fc9c82cbec6e146b5118f0b120b420fe8fcde82178761b0744a42fca67b416139ff4248fb96b892070324b839505a87
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
@@ -3,7 +3,8 @@
|
|
3
3
|
*GitBreeze*, or *git-breeze*, is a Git hook that will scan your current
|
4
4
|
branch name looking for something it recognizes as a [Breeze][b]
|
5
5
|
story number. If it finds one, it will automagically add it, in the [special
|
6
|
-
format][
|
6
|
+
format][b-format], to your commit message. It will also move any m: command
|
7
|
+
to the end of the commit so it reads better in the Breeze story comment.
|
7
8
|
|
8
9
|
## Installation
|
9
10
|
|
@@ -11,13 +12,7 @@ format][pt-format], to your commit message.
|
|
11
12
|
|
12
13
|
You need to get the `git-breeze` binary onto your system.
|
13
14
|
|
14
|
-
- via [
|
15
|
-
|
16
|
-
```bash
|
17
|
-
$ brew install git-breeze
|
18
|
-
```
|
19
|
-
|
20
|
-
- via [RubyGems][rubygems] :pensive: (if you must)
|
15
|
+
- via [RubyGems][rubygems]
|
21
16
|
|
22
17
|
```bash
|
23
18
|
$ gem install git_breeze
|
@@ -58,13 +53,12 @@ in the [special Breeze syntax][b-format].
|
|
58
53
|
$ git commit
|
59
54
|
```
|
60
55
|
|
61
|
-
Will result in a commit message something like:
|
62
|
-
the top)*
|
56
|
+
Will result in a commit message something like:
|
63
57
|
|
64
58
|
```diff
|
65
59
|
|
66
60
|
|
67
|
-
#8675309
|
61
|
+
-- Applies to story #8675309
|
68
62
|
# Please enter the commit message for your changes. Lines starting
|
69
63
|
# with '#' will be ignored, and an empty message aborts the commit.
|
70
64
|
# On branch best_feature_ever-8675309
|
@@ -81,11 +75,11 @@ You should then add a [useful and responsible commit message][tpope]. :heart:
|
|
81
75
|
### Passing commit messages via command line
|
82
76
|
|
83
77
|
If you pass a commit message on the command line the hook will still add the
|
84
|
-
story number, preceded by an empty line, to the end of your message.
|
78
|
+
story number, preceded by an empty line, to the end of your message, as well as any m: comand you might use.
|
85
79
|
|
86
80
|
```bash
|
87
81
|
# on branch named `best_feature_ever-8675309`
|
88
|
-
$ git commit -m'Look at this rad code, yo!'
|
82
|
+
$ git commit -m'Look at this rad code, yo! m:done'
|
89
83
|
```
|
90
84
|
|
91
85
|
Results in this commit message:
|
@@ -93,7 +87,7 @@ Results in this commit message:
|
|
93
87
|
```
|
94
88
|
Look at this rad code, yo!
|
95
89
|
|
96
|
-
#8675309
|
90
|
+
-- Applies to story #8675309 m:done
|
97
91
|
```
|
98
92
|
|
99
93
|
However, if you include the story number in the Breeze format within
|
@@ -123,7 +117,14 @@ name, optionally prefixing it with a hash (`#`). Examples:
|
|
123
117
|
- `your_name/8675309_best_feature_ever`
|
124
118
|
- `your_name/#8675309_best_feature_ever`
|
125
119
|
|
126
|
-
##
|
120
|
+
## Tested with:
|
121
|
+
|
122
|
+
- Command line (-m and with editor -- does not move m:commands)
|
123
|
+
- Brackets Git
|
124
|
+
- SourceTree
|
125
|
+
|
126
|
+
|
127
|
+
## Contributing
|
127
128
|
|
128
129
|
1. Fork it
|
129
130
|
2. Create your feature branch (`git checkout -b my_new_feature`)
|
@@ -135,5 +136,4 @@ name, optionally prefixing it with a hash (`#`). Examples:
|
|
135
136
|
[b]: https://www.breeze.pm/
|
136
137
|
[b-format]: http://www.breeze.pm/help/projects/bitbucket-integration
|
137
138
|
[tpope]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
|
138
|
-
[homebrew]: http://mxcl.github.com/homebrew
|
139
139
|
[rubygems]: http://rubygems.org/gems/git_breeze
|
data/lib/git_breeze/hook.rb
CHANGED
data/lib/git_breeze/version.rb
CHANGED