github_flow_cli 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +41 -6
- data/exe/hubflow +1 -1
- data/lib/github_flow_cli/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: 5b2e3063e075d387e29e4f05f4627dfb664f3279
|
|
4
|
+
data.tar.gz: a1f32725fe4bbffac54db69dad958ca587269e57
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f3b3ce0879fafd58cdcea2feb2233865c7e066f15dc1824af38d2dfd20cbce42f75dab50d64ca1dddc1ea63ada3eece4d6c3f948bd91fcbbbf47c263bcdeceb8
|
|
7
|
+
data.tar.gz: 667647cc1f3a1dcce5a9532b50eb696d577db8419ab126534cd71386ef8e02e5e6a2d0591e084d411f75e5e18e87b0c6b3f9b776a5413e40cb65df6d1ec0551d
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -1,20 +1,55 @@
|
|
|
1
1
|
# GithubFlowCli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Normally how do you push your code to Github to resolve a ticket? Probably like this:
|
|
4
|
+
|
|
5
|
+
1. go to Github issues page or your task manager, create a ticket;
|
|
6
|
+
2. create a branch locally;
|
|
7
|
+
3. finish your work, push it to Github;
|
|
8
|
+
4. go to Github project home page, click "new pull request";
|
|
9
|
+
5. redirect to "new pull request" page, fill in the title and other information.
|
|
10
|
+
|
|
11
|
+
I always found it a waste of my time doing the process above. Especially most of the time I type the same information again and again -- it's very likely the issue contents, the branch name, and the pr contents are connected. Also waiting response from the Chrome browser is not enjoyable.
|
|
12
|
+
|
|
13
|
+
This CLI tool is aiming to fasten the developing flow with Github by automating issue/PR creation according to the repo's convention. It's very new and primitive, but the goal is glory -- to make developing with Github as smoothly as possible!
|
|
4
14
|
|
|
5
15
|
## Installation
|
|
6
16
|
|
|
7
|
-
|
|
17
|
+
```
|
|
18
|
+
gem install github_flow_cli
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
8
22
|
|
|
23
|
+
For the very first version, I present a workflow that is 100% browser-free until the PR reviewing phase. Here's an example:
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
1. When you're in ready position, check your ticket list via `hubflow issue mine`;
|
|
28
|
+
2. Pick a ticket to work on via `hubflow issue start NUMBER`, this will create a branch based on the issue number and name;
|
|
29
|
+
3. After you finished your work, just hit `hubflow pr create`, it will:
|
|
30
|
+
1. create a remote branch;
|
|
31
|
+
2. set upstream;
|
|
32
|
+
3. push code;
|
|
33
|
+
4. create PR based on the issue title.
|
|
34
|
+
|
|
35
|
+
And you can just copy the PR URL from the CLI output to your boss to request a review.
|
|
36
|
+
|
|
37
|
+
You can also create an issue via `hubflow issue create TITLE`
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
For other commands please refer to:
|
|
9
41
|
```
|
|
10
|
-
rake build
|
|
11
|
-
gem install pkg/*.gem
|
|
12
42
|
hubflow help
|
|
13
43
|
```
|
|
14
44
|
|
|
15
|
-
|
|
45
|
+
There's a huge room to improve, including but not limited to:
|
|
46
|
+
|
|
47
|
+
- custom issue title/branch name/PR title template
|
|
48
|
+
- custom issue body/PR body template
|
|
49
|
+
- interactive UI
|
|
50
|
+
- more automations
|
|
16
51
|
|
|
17
|
-
|
|
52
|
+
If you like this idea, not hesitate to join the development!
|
|
18
53
|
|
|
19
54
|
## Development
|
|
20
55
|
|
data/exe/hubflow
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env ruby
|
|
2
2
|
require 'github_flow_cli/cli'
|
|
3
3
|
begin
|
|
4
|
-
GithubFlowCli::Config.setup unless ARGV == ["login"]
|
|
4
|
+
GithubFlowCli::Config.setup unless ARGV == ["login"] || ARGV == ["help"] || ARGV.empty?
|
|
5
5
|
GithubFlowCli::CLI.start
|
|
6
6
|
rescue Interrupt => e
|
|
7
7
|
puts "\nbye."
|