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
Copy file name to clipboardExpand all lines: docs/README.md
+23Lines changed: 23 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,26 @@
1
+
### phlow auth
2
+
```
3
+
git phlow auth -t <target>
4
+
```
5
+
Git phlow auth, authorizes towards a chosen service which can be either `github` or `jira`. Auth is used by git phlow to access and manage issues in your chosen provider.
6
+
7
+
Auth is dependent on a configuration file unless you are using GitHub.com for your issues and Repositories, in that case you can complete omit using the `--target` flag
8
+
9
+
#### Self hosted services or Jira
10
+
To authenticate with your own hosted service or Jira you _must_ provide a valid configuration (see **Configuration** section). Your configuration must contain a base url to where your service is hosted and the name of the service. When authenticating set your `--target` to the name of the configuration e.g.
11
+
12
+
```ini
13
+
[myjiraconfig]
14
+
integration_branch = master
15
+
remote = origin
16
+
service = jira
17
+
issue_url = https://my.jira.instance.com
18
+
delivery_branch_prefix = ready
19
+
```
20
+
```bash
21
+
git phlow auth --target myjiraconfig
22
+
```
23
+
1
24
### Configuration
2
25
git phlow is configured via `.phlow`, or `.gitignore` files., in your local workspace or in the home folder of your computer. The configuration is standard INI files, just like gitconfig.
0 commit comments