add man page - shed-kubectl-secret-decode

siakhooi · Apr 23, 2024 · 4167ffd · 4167ffd
1 parent d0209ba
commit 4167ffd
Show file tree

Hide file tree

Showing 11 changed files with 91 additions and 8 deletions.
diff --git a/Features-Changelog.md b/Features-Changelog.md
@@ -4,6 +4,7 @@ This is the list of features added by release. Bug fixing are excluded.
 
 | release | bin                                                                                             | completions                                       | man                                                                                                                 | config.yaml                                                                                      |
 | ------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
+| `1.24.0`|                                                                                                 |                                                   | shed-kubectl-secret-decode                                                                                          |
 | `1.23.0`|                                                                                                 |                                                   | shed-version                                                                                                        |
 | `1.22.0`|                                                                                                 |                                                   | shed-kubectl-delete                                                                                                 |
 | `1.21.0`|                                                                                                 |                                                   | shed-kubectl-apply                                                                                                  |
@@ -12,7 +13,7 @@ This is the list of features added by release. Bug fixing are excluded.
 | `1.18.0`| shed-kubectl-logs-previous, k-logs-p                                                            |                                                   |
 | `1.17.0`| shed-kubectl-secret-decode, k-secret-decode                                                     |                                                   |                                                                                                                     |                                                                                                  |
 | `1.14.0`| shed-version                                                                                    |                                                   |                                                                                                                     |                                                                                                  |
-| `1.12.0`| shed-contexts (sc)                                                                              |                                                   |                                                                                                                     |                                                                                                  |
+| `1.12.0`| shed-contexts, sc                                                                               |                                                   |                                                                                                                     |                                                                                                  |
 | `1.11.0`| shed-contexts                                                                                   |                                                   |                                                                                                                     |                                                                                                  |
 | `1.10.0`|                                                                                                 |                                                   |                                                                                                                     | .sheds[].kubeconfig[].prompt-name                                                                |
 | `1.9.0` |                                                                                                 |                                                   | shed-kube-resources                                                                                                 |

diff --git a/release.env b/release.env
@@ -1,5 +1,5 @@
 
-RELEASE_VERSION=1.23.1
-RELEASE_TITLE='fix shed-version - to source from lib'
+RELEASE_VERSION=1.24.0
+RELEASE_TITLE='add man page - shed-kubectl-secret-decode'
 
 REGISTRY_USERNAME_DOCKER=siakhooi
diff --git a/src/DEBIAN/control b/src/DEBIAN/control
@@ -1,5 +1,5 @@
 Package: siakhooi-shed
-Version: 1.23.1
+Version: 1.24.0
 Maintainer: Siak Hooi <[email protected]>
 Depends: bash, coreutils, findutils, grep, vim, man-db, sed, siakhooi-devutils-echo-colors (>= 1.0.0), git, siakhooi-textutils (>= 1.7.0), bash-completion, jq
 Architecture: amd64

diff --git a/src/lib/shed-version b/src/lib/shed-version
@@ -1,3 +1,3 @@
 #!/bin/bash
 
-export SHED_VERSION=1.23.1
+export SHED_VERSION=1.24.0
diff --git a/src/md/shed-kubectl-secret-decode.1.md b/src/md/shed-kubectl-secret-decode.1.md
@@ -0,0 +1,33 @@
+% SHED-KUBECTL-SECRET-DECODE(1) Siak Hooi DevUtils 1.1.0|Shed Commands
+% Siak Hooi
+% April 2023
+
+# NAME
+shed-kubectl-secret-decode - read secret, decode all data with base64 and print onto screen.\
+k-secret-decode - alias to shed-kubectl-secret-decode
+
+# SYNOPSIS
+**shed-kubectl-secret-decode** secretName\
+**shed kubectl-secret-decode** secretName\
+**k-secret-decode** secretName
+
+# DESCRIPTION
+Read secret, decode all data with base64 and print onto screen.
+
+# EXAMPLES
+**shed-kubectl-secret-decode** mySecret\
+ \ \ \ \ \ + kubectl --context kube-dev-1 get secrets/mySecret -o yaml\
+ \ \ \ \ \ [key1]\
+ \ \ \ \ \ value 1\
+ \ \
+ \ \ \ \ \ [key2]\
+ \ \ \ \ \ value 2
+
+# LICENSE
+MIT
+
+# BUGS
+Report bugs at https://github.com/siakhooi/shed/issues.
+
+# SEE ALSO
+shed-kubectl(1)
diff --git a/src/md/shed-kubectl.1.md b/src/md/shed-kubectl.1.md
@@ -34,4 +34,5 @@ Report bugs at https://github.com/siakhooi/shed/issues.
 # SEE ALSO
 shed-use(1), shed-kubeconfig-use(1), shed-helm(1), shed-istioctl(1)\
 shed-kubectl-exec-sh(1), shed-kubectl-exec-bash(1)\
-shed-kubectl-scale(1), shed-kubectl-resources(1), shed-kubectl-apply(1), shed-kubectl-delete(1)
+shed-kubectl-scale(1), shed-kubectl-resources(1), shed-kubectl-apply(1), shed-kubectl-delete(1)\
+shed-kubectl-secret-decode(1)
diff --git a/src/md/shed.1.md b/src/md/shed.1.md
@@ -26,6 +26,7 @@ shed is a collection of several bash scripts to manage Kubernetes clusters.
 **shed kubectl-scale**  replicas resourceName\
 **shed kubectl-logs-follow** (pod \| type/name) [container]\
 **shed kubectl-logs-previous** (pod \| type/name) [container]\
+**shed kubectl-secret-decode** secretName\
 **shed helm** [helm arguments]\
 **shed istioctl** [istioctl arguments]\
 \ \
@@ -49,6 +50,7 @@ shed is a collection of several bash scripts to manage Kubernetes clusters.
 **shed-kubectl-scale**  replicas resourceName\
 **shed-kubectl-logs-follow** (pod \| type/name) [container]\
 **shed-kubectl-logs-previous** (pod \| type/name) [container]\
+**shed-kubectl-secret-decode** secretName\
 **shed-helm** [helm arguments]\
 **shed-istioctl** [istioctl arguments]\
 \ \
@@ -70,7 +72,8 @@ shed is a collection of several bash scripts to manage Kubernetes clusters.
 **k-bash** (pod \| type/name) [container]\
 **k-scale** replicas resourceName\
 **k-logs-f** (pod \| type/name) [container]\
-**k-logs-p** (pod \| type/name) [container]
+**k-logs-p** (pod \| type/name) [container]\
+**k-secret-decode** secretName
 
 
 # DESCRIPTION
@@ -136,4 +139,5 @@ shed-value(1), shed-values(1), shed-value-key-list(1), shed-version(1)\
 shed-use(1), shed-kubeconfig-use(1), shed-kubectl(1), shed-helm(1), shed-isioctl(1)\
 shed-kubectl-exec-sh(1),shed-kubectl-exec-bash(1),shed-kubectl-scale(1)\
 shed-kubectl-logs-follow(1),shed-kubectl-logs-previous(1)\
-shed-kubectl-resources(1),shed-kubectl-apply(1),shed-kubectl-delete(1)
+shed-kubectl-resources(1),shed-kubectl-apply(1),shed-kubectl-delete(1)\
+shed-kubectl-secret-decode(1)
diff --git a/tests/bats-test-scripts/man/man-1-shed-kubectl-secret-decode.expected b/tests/bats-test-scripts/man/man-1-shed-kubectl-secret-decode.expected
@@ -0,0 +1,36 @@
+SHED-KUBECTL-SECRET-DECODE(1)                       Shed Commands                       SHED-KUBECTL-SECRET-DECODE(1)
+
+NAME
+       shed-kubectl-secret-decode - read secret, decode all data with base64 and print onto screen.
+       k-secret-decode - alias to shed-kubectl-secret-decode
+
+SYNOPSIS
+       shed-kubectl-secret-decode secretName
+       shed kubectl-secret-decode secretName
+       k-secret-decode secretName
+
+DESCRIPTION
+       Read secret, decode all data with base64 and print onto screen.
+
+EXAMPLES
+       shed-kubectl-secret-decode mySecret
+            + kubectl -context kube-dev-1 get secrets/mySecret -o yaml
+            [key1]
+            value 1
+
+            [key2]
+            value 2
+
+LICENSE
+       MIT
+
+BUGS
+       Report bugs at https://github.com/siakhooi/shed/issues.
+
+SEE ALSO
+       shed-kubectl(1)
+
+AUTHORS
+       Siak Hooi.
+
+Siak Hooi DevUtils 1.1.0                              April 2023                        SHED-KUBECTL-SECRET-DECODE(1)
diff --git a/tests/bats-test-scripts/man/man-1-shed-kubectl.expected b/tests/bats-test-scripts/man/man-1-shed-kubectl.expected
@@ -33,6 +33,7 @@ SEE ALSO
        shed-use(1), shed-kubeconfig-use(1), shed-helm(1), shed-istioctl(1)
        shed-kubectl-exec-sh(1), shed-kubectl-exec-bash(1)
        shed-kubectl-scale(1), shed-kubectl-resources(1), shed-kubectl-apply(1), shed-kubectl-delete(1)
+       shed-kubectl-secret-decode(1)
 
 AUTHORS
        Siak Hooi.

diff --git a/tests/bats-test-scripts/man/man-1-shed.expected b/tests/bats-test-scripts/man/man-1-shed.expected
@@ -24,6 +24,7 @@ SYNOPSIS
        shed kubectl-scale replicas resourceName
        shed kubectl-logs-follow (pod | type/name) [container]
        shed kubectl-logs-previous (pod | type/name) [container]
+       shed kubectl-secret-decode secretName
        shed helm [helm arguments]
        shed istioctl [istioctl arguments]
 
@@ -47,6 +48,7 @@ SYNOPSIS
        shed-kubectl-scale replicas resourceName
        shed-kubectl-logs-follow (pod | type/name) [container]
        shed-kubectl-logs-previous (pod | type/name) [container]
+       shed-kubectl-secret-decode secretName
        shed-helm [helm arguments]
        shed-istioctl [istioctl arguments]
 
@@ -69,6 +71,7 @@ SYNOPSIS
        k-scale replicas resourceName
        k-logs-f (pod | type/name) [container]
        k-logs-p (pod | type/name) [container]
+       k-secret-decode secretName
 
 DESCRIPTION
        shed  programs use environment variable to control which clusters to used.  This allow user to connect to dif-
@@ -131,6 +134,7 @@ SEE ALSO
        shed-kubectl-exec-sh(1),shed-kubectl-exec-bash(1),shed-kubectl-scale(1)
        shed-kubectl-logs-follow(1),shed-kubectl-logs-previous(1)
        shed-kubectl-resources(1),shed-kubectl-apply(1),shed-kubectl-delete(1)
+       shed-kubectl-secret-decode(1)
 
 AUTHORS
        Siak Hooi.

diff --git a/tests/bats-test-scripts/man/man.bats b/tests/bats-test-scripts/man/man.bats
@@ -57,6 +57,9 @@ run-man-test(){
 @test "man shed-kubectl-logs-previous" {
     run-man-test 1 shed-kubectl-logs-previous
 }
+@test "man shed-kubectl-secret-decode" {
+    run-man-test 1 shed-kubectl-secret-decode
+}
 @test "man shed-kubectl-scale" {
     run-man-test 1 shed-kubectl-scale
 }