You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|||[](https://goreportcard.com/report/github.com/Praqma/git-phlow)|[](https://coveralls.io/github/Praqma/git-phlow?branch=master)|[](http://waffle.io/Praqma/git-phlow)|
10
10
11
11
12
-
git-phlow (pronounced _"git flow"_), is a CLI extension for git, which provides an extra set of commands to easily use our pragmatic workflow called **the phlow**. It provides a branching model, which makes collaboration. It also provides automatic issue tracking using [github](https://github.com) issues with [waffle](https://waffle.io/). The branching models uses branches prefixed with ready(can be configured), to mark delivered task to the remote repository from where automation services can pick up and integrate the changes into the stable branch.
12
+
git-phlow (pronounced _"git flow"_), is a CLI extension for git, which provides an extra set of commands to easily use our pragmatic workflow called **the phlow**. It provides a branching model which makes collaboration easy. It also provides automatic issue tracking using [GitHub](https://github.com) issues with [Waffle](https://waffle.io/). The branching model uses branches prefixed with `ready`(can be configured) to mark delivered tasks to the remote repository from where automation services can pick up and integrate the changes into the stable branch.
13
13
14
-
Read about the pragmatic workflow, **the phlow**,[here](http://www.praqma.com/stories/a-pragmatic-workflow/).
14
+
Read about the pragmatic workflow, **the phlow**[here](http://www.praqma.com/stories/a-pragmatic-workflow/).
15
15
16
16
git-phlows core features will include:
17
17
@@ -24,16 +24,16 @@ git-phlows core features will include:
24
24
-*build for pretest integration*: deliver will push your branch to GitHub, ready for your pipeline to pull, integrate, test and merge back in.
25
25
26
26
## Using the phlow (workflow)
27
-
To get started using the-phlow, read [praqmas](http://www.praqma.com/stories/a-pragmatic-workflow/) article about how the phlow works, and how to configure waffle for your projects.
28
-
A few things nees to be configured before hand:
27
+
To get started using the-phlow, read [praqmas](http://www.praqma.com/stories/a-pragmatic-workflow/) article about how the phlow works, and how to configure Waffle for your projects.
28
+
A few things nees to be configured before hand:
29
29
30
30
- Activate __issues__ on the designated GitHub repository
31
31
- Create the __labels__ used by the phlow. Read the article above to find them
32
32
- Download and install _git-phlow_ using _brew_ or _wget_
33
33
- Start creating tasks in GitHub issues
34
34
35
35
## installing git-phlow (tool)
36
-
### Using Homebrew
36
+
### Using Homebrew
37
37
If you are a Mac user and have homebrew installed, you can tap our official repository.
38
38
39
39
```shell
@@ -42,10 +42,10 @@ brew tap praqma/praqma-tap
42
42
43
43
#Install git-phlow
44
44
brew install git-phlow
45
-
```
45
+
```
46
46
### Linux
47
47
You can also install git-phlow running the following commands. That will download and install the project.
Download the latest release [here](https://github.com/Praqma/git-phlow/releases) and extract it with zip. Place it in the windows path and now it is availbe as `git phlow`.
57
57
58
-
In the near future the installation will be available via [chocolatey](https://chocolatey.org/).
58
+
In the near future the installation will be available via [chocolatey](https://chocolatey.org/).
59
59
60
60
##### Compatibility
61
61
- Powershell v5.1+
62
62
- command prompt - only with the `--no-color` flag
63
63
64
64
### Using git Phlow
65
-
- Go to GitHub or Waffle and look at the issues
66
-
- Find an issue to work on, and note it's id eg. `42`
67
-
- Then go to the local git repository and type:
65
+
- First time, authenticate to GitHub:
68
66
69
67
```git
70
-
git phlow workon 42
68
+
git phlow auth
69
+
```
71
70
72
-
#creates branch: 42-some-issue-title
71
+
- Look at the issues by using `ghi` or going to GitHub or Waffle
72
+
- Find an issue to work on, and note its id e.g. `42`
73
+
- Go to the local git repository and type:
74
+
75
+
```git
76
+
git phlow workon 42
73
77
```
78
+
79
+
- This will create a branch: `42-some-issue-title`
74
80
- Make the changes and complete the task
75
-
- When it's done, type:
81
+
- When it's done, type:
76
82
77
83
```git
78
84
git phlow wrapup --hard
@@ -81,35 +87,36 @@ git phlow wrapup --hard
81
87
#alternately you can add your changes manually and use
82
88
git phlow wrapup
83
89
```
84
-
- Now that the changes are ready, type:
90
+
- Now that the changes are ready, type:
85
91
86
92
```git
87
93
git phlow deliver
88
94
# renames local branch to: delivered/42-some-issue-title
If the automation tools have been configured to listen for __ready/__ branches, they will pick up the branch and integrate them with the stable branch.
93
-
if you do not have an automation system, you can deliver the work to your default branch by doing a local deliver instead.
98
+
If the automation tools have been configured to listen for __ready/__ branches, they will pick up the branch and integrate them with the stable branch.
99
+
If you do not have an automation system, you can deliver the work to your default branch by doing a local deliver instead.
94
100
95
101
```git
96
102
git phlow deliver --local
97
-
98
-
#changes branch to master
99
-
#merges changes from 42-some-issue-branch
100
-
#pushes changes to github
101
103
```
104
+
105
+
- Changes branch to `master`
106
+
- Merges changes from `42-some-issue-branch`
107
+
- Pushes changes to GitHub
108
+
102
109
### Automation systems
103
-
For automation systems we use, travis CI, Concourse CI and Jenkins. They can all be configured to follow the phlow and listen for ready branches.
104
-
You can see the concourse pipeline configured for this project [here](https://concourse.kubernetes.praqma.cloud/teams/main/pipelines/git-phlow)
110
+
We use Travis CI, Concourse CI and Jenkins. They can all be configured to follow the phlow and listen for ready branches.
111
+
You can see the Concourse pipeline configured for this project [here](https://concourse.kubernetes.praqma.cloud/teams/main/pipelines/git-phlow)
105
112
106
113
### git-phlow on Windows
107
114
108
115
We recommend running git-phlow using _PowerShell_.
109
-
There are known issues with _cmd_ rendering formatted text incorrectly, and _git bash_'s input being handled incorrectly.
116
+
There are known issues with _cmd_ rendering formatted text incorrect, and _git bash_'s input being handled incorrectly.
110
117
111
118
## Project status
112
-
This is the official repository for the git-phlow extension. The project is currently under development and many additions are still to come. but version 0.1.5 is available and stable for both linux and Mac.
119
+
This is the official repository for the git-phlow extension. The project is currently under development and many additions are still to come. but version 0.1.5 is available and stable for both linux and Mac.
0 commit comments