Skip to content

Commit 705bec7

Browse files
coufaljacoufalja
committed
Improve release and regenerate docs
1 parent cf25fc7 commit 705bec7

18 files changed

+213
-47
lines changed

‎.github/workflows/release.yml

+5-4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ on:
77

88
env:
99
REGISTRY: ghcr.io
10+
BINARY_NAME: ${{ github.repository }}
1011
IMAGE_NAME: ${{ github.repository }}
1112
TAG: ${{ github.ref_name }}
1213

@@ -30,14 +31,14 @@ jobs:
3031
GOARCH: ${{ matrix.goarch }}
3132
shell: bash
3233
run: |
33-
GOOS=${{ matrix.goos }} GOARCH=${{ matrix.goarch }} go build -o git2kube -ldflags '-w -s -X 'github.com/wandera/git2kube/cmd.Version=${{ env.TAG }} \
34+
GOOS=${{ matrix.goos }} GOARCH=${{ matrix.goarch }} go build -o ${{ env.BINARY_NAME }} -ldflags '-w -s -X 'github.com/wandera/${{ env.BINARY_NAME }}/cmd.Version=${{ env.TAG }} \
3435
&& mkdir dist \
35-
&& mv git2kube dist/git2kube \
36-
&& tar -czvf git2kube-${{ matrix.goos }}-${{ matrix.goarch }}.tar.gz -C dist/ .
36+
&& mv ${{ env.BINARY_NAME }} dist/${{ env.BINARY_NAME }} \
37+
&& tar -czvf ${{ env.BINARY_NAME }}-${{ matrix.goos }}-${{ matrix.goarch }}.tar.gz -C dist/ .
3738
- name: Release
3839
uses: wandera/action-gh-release@v1
3940
with:
40-
files: git2kube-${{ matrix.goos }}-${{ matrix.goarch }}.tar.gz
41+
files: ${{ env.BINARY_NAME }}-${{ matrix.goos }}-${{ matrix.goarch }}.tar.gz
4142

4243
release-docker-image:
4344
runs-on: ubuntu-latest

‎docs/git2kube.md

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Commandline tool for loading files from git repository into K8s ConfigMap
1515

1616
### SEE ALSO
1717

18+
* [git2kube completion](git2kube_completion.md) - Generate the autocompletion script for the specified shell
1819
* [git2kube gendoc](git2kube_gendoc.md) - Generates documentation for this tool in Markdown format
1920
* [git2kube load](git2kube_load.md) - Loads files from git repository into target
2021
* [git2kube version](git2kube_version.md) - Print the version information

‎docs/git2kube_completion.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## git2kube completion
2+
3+
Generate the autocompletion script for the specified shell
4+
5+
### Synopsis
6+
7+
Generate the autocompletion script for git2kube for the specified shell.
8+
See each sub-command's help for details on how to use the generated script.
9+
10+
11+
### Options
12+
13+
```
14+
-h, --help help for completion
15+
```
16+
17+
### Options inherited from parent commands
18+
19+
```
20+
-l, --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
21+
```
22+
23+
### SEE ALSO
24+
25+
* [git2kube](git2kube.md) - Git to ConfigMap conversion tool
26+
* [git2kube completion bash](git2kube_completion_bash.md) - Generate the autocompletion script for bash
27+
* [git2kube completion fish](git2kube_completion_fish.md) - Generate the autocompletion script for fish
28+
* [git2kube completion powershell](git2kube_completion_powershell.md) - Generate the autocompletion script for powershell
29+
* [git2kube completion zsh](git2kube_completion_zsh.md) - Generate the autocompletion script for zsh
30+

‎docs/git2kube_completion_bash.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## git2kube completion bash
2+
3+
Generate the autocompletion script for bash
4+
5+
### Synopsis
6+
7+
Generate the autocompletion script for the bash shell.
8+
9+
This script depends on the 'bash-completion' package.
10+
If it is not installed already, you can install it via your OS's package manager.
11+
12+
To load completions in your current shell session:
13+
14+
source <(git2kube completion bash)
15+
16+
To load completions for every new session, execute once:
17+
18+
#### Linux:
19+
20+
git2kube completion bash > /etc/bash_completion.d/git2kube
21+
22+
#### macOS:
23+
24+
git2kube completion bash > $(brew --prefix)/etc/bash_completion.d/git2kube
25+
26+
You will need to start a new shell for this setup to take effect.
27+
28+
29+
```
30+
git2kube completion bash
31+
```
32+
33+
### Options
34+
35+
```
36+
-h, --help help for bash
37+
--no-descriptions disable completion descriptions
38+
```
39+
40+
### Options inherited from parent commands
41+
42+
```
43+
-l, --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
44+
```
45+
46+
### SEE ALSO
47+
48+
* [git2kube completion](git2kube_completion.md) - Generate the autocompletion script for the specified shell
49+

‎docs/git2kube_completion_fish.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## git2kube completion fish
2+
3+
Generate the autocompletion script for fish
4+
5+
### Synopsis
6+
7+
Generate the autocompletion script for the fish shell.
8+
9+
To load completions in your current shell session:
10+
11+
git2kube completion fish | source
12+
13+
To load completions for every new session, execute once:
14+
15+
git2kube completion fish > ~/.config/fish/completions/git2kube.fish
16+
17+
You will need to start a new shell for this setup to take effect.
18+
19+
20+
```
21+
git2kube completion fish [flags]
22+
```
23+
24+
### Options
25+
26+
```
27+
-h, --help help for fish
28+
--no-descriptions disable completion descriptions
29+
```
30+
31+
### Options inherited from parent commands
32+
33+
```
34+
-l, --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
35+
```
36+
37+
### SEE ALSO
38+
39+
* [git2kube completion](git2kube_completion.md) - Generate the autocompletion script for the specified shell
40+

‎docs/git2kube_completion_powershell.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## git2kube completion powershell
2+
3+
Generate the autocompletion script for powershell
4+
5+
### Synopsis
6+
7+
Generate the autocompletion script for powershell.
8+
9+
To load completions in your current shell session:
10+
11+
git2kube completion powershell | Out-String | Invoke-Expression
12+
13+
To load completions for every new session, add the output of the above command
14+
to your powershell profile.
15+
16+
17+
```
18+
git2kube completion powershell [flags]
19+
```
20+
21+
### Options
22+
23+
```
24+
-h, --help help for powershell
25+
--no-descriptions disable completion descriptions
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-l, --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
32+
```
33+
34+
### SEE ALSO
35+
36+
* [git2kube completion](git2kube_completion.md) - Generate the autocompletion script for the specified shell
37+

‎docs/git2kube_completion_zsh.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## git2kube completion zsh
2+
3+
Generate the autocompletion script for zsh
4+
5+
### Synopsis
6+
7+
Generate the autocompletion script for the zsh shell.
8+
9+
If shell completion is not already enabled in your environment you will need
10+
to enable it. You can execute the following once:
11+
12+
echo "autoload -U compinit; compinit" >> ~/.zshrc
13+
14+
To load completions in your current shell session:
15+
16+
source <(git2kube completion zsh)
17+
18+
To load completions for every new session, execute once:
19+
20+
#### Linux:
21+
22+
git2kube completion zsh > "${fpath[1]}/_git2kube"
23+
24+
#### macOS:
25+
26+
git2kube completion zsh > $(brew --prefix)/share/zsh/site-functions/_git2kube
27+
28+
You will need to start a new shell for this setup to take effect.
29+
30+
31+
```
32+
git2kube completion zsh [flags]
33+
```
34+
35+
### Options
36+
37+
```
38+
-h, --help help for zsh
39+
--no-descriptions disable completion descriptions
40+
```
41+
42+
### Options inherited from parent commands
43+
44+
```
45+
-l, --log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
46+
```
47+
48+
### SEE ALSO
49+
50+
* [git2kube completion](git2kube_completion.md) - Generate the autocompletion script for the specified shell
51+

‎docs/git2kube_gendoc.md

-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Generates documentation for this tool in Markdown format
44

5-
### Synopsis
6-
7-
Generates documentation for this tool in Markdown format
8-
95
```
106
git2kube gendoc [flags]
117
```

‎docs/git2kube_load.md

-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Loads files from git repository into target
44

5-
### Synopsis
6-
7-
Loads files from git repository into target
8-
95
### Options
106

117
```

‎docs/git2kube_load_configmap.md

-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Loads files from git repository into ConfigMap
44

5-
### Synopsis
6-
7-
Loads files from git repository into ConfigMap
8-
95
```
106
git2kube load configmap [flags]
117
```

‎docs/git2kube_load_folder.md

-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Loads files from git repository into Folder
44

5-
### Synopsis
6-
7-
Loads files from git repository into Folder
8-
95
```
106
git2kube load folder [flags]
117
```

‎docs/git2kube_load_secret.md

-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Loads files from git repository into Secret
44

5-
### Synopsis
6-
7-
Loads files from git repository into Secret
8-
95
```
106
git2kube load secret [flags]
117
```

‎docs/git2kube_version.md

-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Print the version information
44

5-
### Synopsis
6-
7-
Print the version information
8-
95
```
106
git2kube version [flags]
117
```

‎docs/git2kube_watch.md

-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Runs watcher that periodically check the provided repository
44

5-
### Synopsis
6-
7-
Runs watcher that periodically check the provided repository
8-
95
### Options
106

117
```

‎docs/git2kube_watch_configmap.md

-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Runs watcher that periodically check the provided repository and updates K8s ConfigMap accordingly
44

5-
### Synopsis
6-
7-
Runs watcher that periodically check the provided repository and updates K8s ConfigMap accordingly
8-
95
```
106
git2kube watch configmap [flags]
117
```

‎docs/git2kube_watch_folder.md

-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Runs watcher that periodically check the provided repository and updates target folder accordingly
44

5-
### Synopsis
6-
7-
Runs watcher that periodically check the provided repository and updates target folder accordingly
8-
95
```
106
git2kube watch folder [flags]
117
```

‎docs/git2kube_watch_secret.md

-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
Runs watcher that periodically check the provided repository and updates K8s Secret accordingly
44

5-
### Synopsis
6-
7-
Runs watcher that periodically check the provided repository and updates K8s Secret accordingly
8-
95
```
106
git2kube watch secret [flags]
117
```

‎hooks/build

-3
This file was deleted.

0 commit comments

Comments
 (0)