Skip to content

Commit f570221

Browse files
authored
fix: update deps + increase commands docu (#201)
1 parent b064676 commit f570221

30 files changed

+161
-227
lines changed

docs/docs/02-cli/awesome-ci.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Awesome CI make your release tagging easy
88
### Synopsis
99

1010
Awesome CI make your release tagging easy
11-
Comatible with CI pipelines like Jenkins and GitHub
12-
Find more information and examples at: https://github.com/fullstack-devops/awesome-ci
11+
Comatible with CI pipelines like Jenkins and GitHub
12+
Find more information and examples at: https://github.com/fullstack-devops/awesome-ci
1313

1414
```
1515
awesome-ci [flags]
@@ -24,11 +24,10 @@ awesome-ci [flags]
2424

2525
### SEE ALSO
2626

27-
* [awesome-ci connect](./awesome-ci_connect) - connect persistent to github by creating an encrypted rc file
28-
* [awesome-ci parse](./awesome-ci_parse) - parse json and yaml files and inspect values like jq + more
29-
* [awesome-ci pr](./awesome-ci_pr) - pull request
30-
* [awesome-ci release](./awesome-ci_release) - release
27+
* [awesome-ci connect](./awesome-ci_connect) - Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise
28+
* [awesome-ci parse](./awesome-ci_parse) - inspect and parse JSON and YAML files to retrieve values, similar to jq with additional features
29+
* [awesome-ci pr](./awesome-ci_pr) - Manage GitHub pull requests
30+
* [awesome-ci release](./awesome-ci_release) - Manage GitHub releases with ease
3131
* [awesome-ci transform](./awesome-ci_transform) - transform given input to json
32-
* [awesome-ci version](./awesome-ci_version) - Print the version number of Awesome-CI
3332

34-
###### Auto generated by spf13/cobra on 8-Sep-2024
33+
###### Auto generated by spf13/cobra on 5-Dec-2024

docs/docs/02-cli/awesome-ci_connect.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@ title: "_ connect"
33
---
44
## awesome-ci connect
55

6-
connect persistent to github by creating an encrypted rc file
6+
Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise
77

88
### Synopsis
99

10-
connect initial to a GitHub or GitHub Enterprise
11-
at some point you can also connect to GitLab (not yet implemented)
12-
this is only useful without a runner or in an jenkins pipeline
10+
Initial connection to a GitHub or GitHub Enterprise
11+
creates an encrypted .rc file to persistently connect to GitHub
12+
soon you can also connect to GitLab (not yet implemented)
13+
useful without a runner or in an jenkins pipeline
1314

1415
```
1516
awesome-ci connect [flags]
@@ -30,8 +31,8 @@ awesome-ci connect [flags]
3031
### SEE ALSO
3132

3233
* [awesome-ci](./awesome-ci) - Awesome CI make your release tagging easy
33-
* [awesome-ci connect check](./awesome-ci_connect_check) - check current connection
34+
* [awesome-ci connect check](./awesome-ci_connect_check) - verify current connection is working
3435
* [awesome-ci connect github](./awesome-ci_connect_github) - connect initial to a GitHub or GitHub Enterprise
35-
* [awesome-ci connect remove](./awesome-ci_connect_remove) - remove all connection files and secrets
36+
* [awesome-ci connect remove](./awesome-ci_connect_remove) - remove all persisted connection files and secrets
3637

37-
###### Auto generated by spf13/cobra on 8-Sep-2024
38+
###### Auto generated by spf13/cobra on 5-Dec-2024

docs/docs/02-cli/awesome-ci_connect_check.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "_ connect check"
33
---
44
## awesome-ci connect check
55

6-
check current connection
6+
verify current connection is working
77

88
```
99
awesome-ci connect check [flags]
@@ -23,6 +23,6 @@ awesome-ci connect check [flags]
2323

2424
### SEE ALSO
2525

26-
* [awesome-ci connect](./awesome-ci_connect) - connect persistent to github by creating an encrypted rc file
26+
* [awesome-ci connect](./awesome-ci_connect) - Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise
2727

28-
###### Auto generated by spf13/cobra on 8-Sep-2024
28+
###### Auto generated by spf13/cobra on 5-Dec-2024

docs/docs/02-cli/awesome-ci_connect_github.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ awesome-ci connect github [flags]
1414
```
1515
-h, --help help for github
1616
-r, --repository string (required) repo eg.: octo-org/octo-repo
17-
-s, --server string (required) github instance to connect (default "https://github.com")
17+
-s, --server string github instance to connect, default: https://github.com (default "https://github.com")
1818
-t, --token string (required) plain token eg.: ghp_*****
1919
```
2020

@@ -26,6 +26,6 @@ awesome-ci connect github [flags]
2626

2727
### SEE ALSO
2828

29-
* [awesome-ci connect](./awesome-ci_connect) - connect persistent to github by creating an encrypted rc file
29+
* [awesome-ci connect](./awesome-ci_connect) - Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise
3030

31-
###### Auto generated by spf13/cobra on 8-Sep-2024
31+
###### Auto generated by spf13/cobra on 5-Dec-2024

docs/docs/02-cli/awesome-ci_connect_remove.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "_ connect remove"
33
---
44
## awesome-ci connect remove
55

6-
remove all connection files and secrets
6+
remove all persisted connection files and secrets
77

88
```
99
awesome-ci connect remove [flags]
@@ -23,6 +23,6 @@ awesome-ci connect remove [flags]
2323

2424
### SEE ALSO
2525

26-
* [awesome-ci connect](./awesome-ci_connect) - connect persistent to github by creating an encrypted rc file
26+
* [awesome-ci connect](./awesome-ci_connect) - Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise
2727

28-
###### Auto generated by spf13/cobra on 8-Sep-2024
28+
###### Auto generated by spf13/cobra on 5-Dec-2024

docs/docs/02-cli/awesome-ci_parse.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "_ parse"
33
---
44
## awesome-ci parse
55

6-
parse json and yaml files and inspect values like jq + more
6+
inspect and parse JSON and YAML files to retrieve values, similar to jq with additional features
77

88
```
99
awesome-ci parse [flags]
@@ -25,7 +25,7 @@ awesome-ci parse [flags]
2525

2626
* [awesome-ci](./awesome-ci) - Awesome CI make your release tagging easy
2727
* [awesome-ci parse json](./awesome-ci_parse_json) - parse a json string or file
28-
* [awesome-ci parse version](./awesome-ci_parse_version) - Parse the given version string and validate against semver
28+
* [awesome-ci parse version](./awesome-ci_parse_version) - Validate the given version string against semver syntax
2929
* [awesome-ci parse yaml](./awesome-ci_parse_yaml) - parse a yaml string or file
3030

31-
###### Auto generated by spf13/cobra on 8-Sep-2024
31+
###### Auto generated by spf13/cobra on 5-Dec-2024

docs/docs/02-cli/awesome-ci_parse_json.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ awesome-ci parse json [flags]
2626

2727
### SEE ALSO
2828

29-
* [awesome-ci parse](./awesome-ci_parse) - parse json and yaml files and inspect values like jq + more
29+
* [awesome-ci parse](./awesome-ci_parse) - inspect and parse JSON and YAML files to retrieve values, similar to jq with additional features
3030

31-
###### Auto generated by spf13/cobra on 8-Sep-2024
31+
###### Auto generated by spf13/cobra on 5-Dec-2024

docs/docs/02-cli/awesome-ci_parse_version.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "_ parse version"
33
---
44
## awesome-ci parse version
55

6-
Parse the given version string and validate against semver
6+
Validate the given version string against semver syntax
77

88
```
99
awesome-ci parse version [flags]
@@ -23,6 +23,6 @@ awesome-ci parse version [flags]
2323

2424
### SEE ALSO
2525

26-
* [awesome-ci parse](./awesome-ci_parse) - parse json and yaml files and inspect values like jq + more
26+
* [awesome-ci parse](./awesome-ci_parse) - inspect and parse JSON and YAML files to retrieve values, similar to jq with additional features
2727

28-
###### Auto generated by spf13/cobra on 8-Sep-2024
28+
###### Auto generated by spf13/cobra on 5-Dec-2024

docs/docs/02-cli/awesome-ci_parse_yaml.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ awesome-ci parse yaml [flags]
2626

2727
### SEE ALSO
2828

29-
* [awesome-ci parse](./awesome-ci_parse) - parse json and yaml files and inspect values like jq + more
29+
* [awesome-ci parse](./awesome-ci_parse) - inspect and parse JSON and YAML files to retrieve values, similar to jq with additional features
3030

31-
###### Auto generated by spf13/cobra on 8-Sep-2024
31+
###### Auto generated by spf13/cobra on 5-Dec-2024

docs/docs/02-cli/awesome-ci_pr.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ title: "_ pr"
33
---
44
## awesome-ci pr
55

6-
pull request
6+
Manage GitHub pull requests
77

88
### Synopsis
99

10-
All software has versions. This is Awesome-CI's
10+
The pull request command is used to manage GitHub pull requests. It provides subcommands to get pull request info, allowing you to get all infos about a pull request in GitHub.
1111

1212
```
1313
awesome-ci pr [flags]
@@ -28,6 +28,6 @@ awesome-ci pr [flags]
2828
### SEE ALSO
2929

3030
* [awesome-ci](./awesome-ci) - Awesome CI make your release tagging easy
31-
* [awesome-ci pr info](./awesome-ci_pr_info) - get pull request info
31+
* [awesome-ci pr info](./awesome-ci_pr_info) - Get pull request info
3232

33-
###### Auto generated by spf13/cobra on 8-Sep-2024
33+
###### Auto generated by spf13/cobra on 5-Dec-2024

0 commit comments

Comments
 (0)