Update docs
Signed-off-by: jolheiser <john.olheiser@gmail.com>main v0.0.2
parent
c950b9e903
commit
37d0e9f29b
80
DOCS.md
80
DOCS.md
|
@ -16,8 +16,7 @@ git-ea
|
||||||
|
|
||||||
```
|
```
|
||||||
[--help]
|
[--help]
|
||||||
[--v]
|
[--version,-v]
|
||||||
[--version]
|
|
||||||
```
|
```
|
||||||
**Usage**:
|
**Usage**:
|
||||||
|
|
||||||
|
@ -28,10 +27,7 @@ git-ea <cmd>
|
||||||
**--help**: Show help
|
**--help**: Show help
|
||||||
|
|
||||||
|
|
||||||
**--v**: --version
|
**--version,-v**: Print git-ea version
|
||||||
|
|
||||||
|
|
||||||
**--version**: Print git-ea version
|
|
||||||
|
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
@ -61,13 +57,10 @@ backport cherry-picks a commit and applies it to a clean branch based on `releas
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
[--f]=[value]
|
[--from,-f]=[value]
|
||||||
[--from]=[value]
|
|
||||||
[--help]
|
[--help]
|
||||||
[--l]
|
[--list,-l]
|
||||||
[--list]
|
[--to,-t]=[value]
|
||||||
[--t]=[value]
|
|
||||||
[--to]=[value]
|
|
||||||
```
|
```
|
||||||
**Usage**:
|
**Usage**:
|
||||||
|
|
||||||
|
@ -75,25 +68,16 @@ backport cherry-picks a commit and applies it to a clean branch based on `releas
|
||||||
backport --from [release=main] --to [release=latest]
|
backport --from [release=main] --to [release=latest]
|
||||||
```
|
```
|
||||||
|
|
||||||
**--f**="": --from
|
**--from,-f**="": Release to backport from (ex: `main`, default: main)
|
||||||
|
|
||||||
|
|
||||||
**--from**="": Release to backport from (ex: `main`, default: main)
|
|
||||||
|
|
||||||
|
|
||||||
**--help**: Show help
|
**--help**: Show help
|
||||||
|
|
||||||
|
|
||||||
**--l**: --list
|
**--list,-l**: Open repository to see needed backports
|
||||||
|
|
||||||
|
|
||||||
**--list**: Open repository to see needed backports
|
**--to,-t**="": Release to backport to (ex: `1.17`, default: `latest`)
|
||||||
|
|
||||||
|
|
||||||
**--t**="": --to
|
|
||||||
|
|
||||||
|
|
||||||
**--to**="": Release to backport to (ex: `1.17`, default: `latest`)
|
|
||||||
|
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
@ -104,13 +88,10 @@ branch creates a new branch called `name` based on `base`
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
[--b]=[value]
|
[--base,-b]=[value]
|
||||||
[--base]=[value]
|
|
||||||
[--help]
|
[--help]
|
||||||
[--l]
|
[--list,-l]
|
||||||
[--list]
|
[--no-fetch,-nf]
|
||||||
[--nf]
|
|
||||||
[--no-fetch]
|
|
||||||
```
|
```
|
||||||
**Usage**:
|
**Usage**:
|
||||||
|
|
||||||
|
@ -118,25 +99,16 @@ branch creates a new branch called `name` based on `base`
|
||||||
branch --base [ref=main] <name>
|
branch --base [ref=main] <name>
|
||||||
```
|
```
|
||||||
|
|
||||||
**--b**="": --base (default: `main`)
|
**--base,-b**="": Ref to base from (default: `main`)
|
||||||
|
|
||||||
|
|
||||||
**--base**="": Ref to base from (default: `main`)
|
|
||||||
|
|
||||||
|
|
||||||
**--help**: Show help
|
**--help**: Show help
|
||||||
|
|
||||||
|
|
||||||
**--l**: --list
|
**--list,-l**: List branches available
|
||||||
|
|
||||||
|
|
||||||
**--list**: List branches available
|
**--no-fetch,-nf**: Skip fetching
|
||||||
|
|
||||||
|
|
||||||
**--nf**: --no-fetch
|
|
||||||
|
|
||||||
|
|
||||||
**--no-fetch**: Skip fetching
|
|
||||||
|
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
@ -147,11 +119,9 @@ frontport cherry-picks a commit and applies it to a clean branch based on `relea
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
[--f]=[value]
|
[--from,-f]=[value]
|
||||||
[--from]=[value]
|
|
||||||
[--help]
|
[--help]
|
||||||
[--t]=[value]
|
[--to,-t]=[value]
|
||||||
[--to]=[value]
|
|
||||||
```
|
```
|
||||||
**Usage**:
|
**Usage**:
|
||||||
|
|
||||||
|
@ -159,19 +129,13 @@ frontport cherry-picks a commit and applies it to a clean branch based on `relea
|
||||||
frontport --from [release=latest] --to [release=main]
|
frontport --from [release=latest] --to [release=main]
|
||||||
```
|
```
|
||||||
|
|
||||||
**--f**="": --from
|
**--from,-f**="": Release to frontport from (ex: `1.17`, default: <latest>)
|
||||||
|
|
||||||
|
|
||||||
**--from**="": Release to frontport from (ex: `1.17`, default: <latest>)
|
|
||||||
|
|
||||||
|
|
||||||
**--help**: Show help
|
**--help**: Show help
|
||||||
|
|
||||||
|
|
||||||
**--t**="": --to
|
**--to,-t**="": Release to frontport to (ex: `main`, default: `main`)
|
||||||
|
|
||||||
|
|
||||||
**--to**="": Release to frontport to (ex: `main`, default: `main`)
|
|
||||||
|
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
@ -221,8 +185,7 @@ pr pulls down a pull request for testing
|
||||||
|
|
||||||
```
|
```
|
||||||
[--help]
|
[--help]
|
||||||
[--i]
|
[--ide,-i]
|
||||||
[--ide]
|
|
||||||
```
|
```
|
||||||
**Usage**:
|
**Usage**:
|
||||||
|
|
||||||
|
@ -233,10 +196,7 @@ pr <index>
|
||||||
**--help**: Show help
|
**--help**: Show help
|
||||||
|
|
||||||
|
|
||||||
**--i**: --ide
|
**--ide,-i**: Start an IDE for this PR
|
||||||
|
|
||||||
|
|
||||||
**--ide**: Start an IDE for this PR
|
|
||||||
|
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
2
go.mod
2
go.mod
|
@ -8,7 +8,7 @@ require (
|
||||||
github.com/peterbourgon/ff/v3 v3.3.0
|
github.com/peterbourgon/ff/v3 v3.3.0
|
||||||
github.com/rs/zerolog v1.27.0
|
github.com/rs/zerolog v1.27.0
|
||||||
github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
|
github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
|
||||||
go.jolheiser.com/ffmd v0.0.2
|
go.jolheiser.com/ffmd v0.0.3
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
|
|
4
go.sum
4
go.sum
|
@ -97,8 +97,8 @@ github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5Cc
|
||||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||||
github.com/xanzy/ssh-agent v0.3.0 h1:wUMzuKtKilRgBAD1sUb8gOwwRr2FGoBVumcjoOACClI=
|
github.com/xanzy/ssh-agent v0.3.0 h1:wUMzuKtKilRgBAD1sUb8gOwwRr2FGoBVumcjoOACClI=
|
||||||
github.com/xanzy/ssh-agent v0.3.0/go.mod h1:3s9xbODqPuuhK9JV1R321M/FlMZSBvE5aY6eAcqrDh0=
|
github.com/xanzy/ssh-agent v0.3.0/go.mod h1:3s9xbODqPuuhK9JV1R321M/FlMZSBvE5aY6eAcqrDh0=
|
||||||
go.jolheiser.com/ffmd v0.0.2 h1:rNOUq5wQKsNQU3pc51XNaks9+GK9hLlFTsPHrQhlGRU=
|
go.jolheiser.com/ffmd v0.0.3 h1:QSKpK0cEZlAswGZuzr9b0dvHG+2HQd362k1DRDwMfrY=
|
||||||
go.jolheiser.com/ffmd v0.0.2/go.mod h1:NLhcXZqO+dwvQ2/X9z3TUA3gORxUuRlgOjKC931vCZ4=
|
go.jolheiser.com/ffmd v0.0.3/go.mod h1:NLhcXZqO+dwvQ2/X9z3TUA3gORxUuRlgOjKC931vCZ4=
|
||||||
golang.org/x/crypto v0.0.0-20190219172222-a4c6cb3142f2/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
|
golang.org/x/crypto v0.0.0-20190219172222-a4c6cb3142f2/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
|
||||||
golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4=
|
golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4=
|
||||||
golang.org/x/crypto v0.0.0-20210421170649-83a5a9bb288b h1:7mWr3k41Qtv8XlltBkDkl8LoP3mpSgBW8BUoxtEdbXg=
|
golang.org/x/crypto v0.0.0-20210421170649-83a5a9bb288b h1:7mWr3k41Qtv8XlltBkDkl8LoP3mpSgBW8BUoxtEdbXg=
|
||||||
|
|
Loading…
Reference in New Issue