fix(mkdocs): fix mkdocs GHA

.github/dependabot.yml

@@ -29,4 +29,4 @@ updates:
       - "dependencies"
     commit-message:
       prefix: "feat"
-      include: "scope"
+      include: "scope"

.github/workflows/commitlint.yml

@@ -12,4 +12,4 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: wagoid/commitlint-github-action@v5
+      - uses: wagoid/commitlint-github-action@v5

.github/workflows/lint.yml

@@ -33,4 +33,4 @@ jobs:
           version: v1.59.1
           args: -c .golang-ci.yml -v --timeout=5m
         env:
-          GO111MODULES: off
+          GO111MODULES: off

.github/workflows/mkdocs.yml

@@ -1,23 +1,43 @@
-name: mkdocs 
+name: mkdocs
 
 on:
   push:
     branches:
-      - master 
+      - master
       - main
+
 permissions:
   contents: write
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - run: make docgen
-
-      - name: Deploy docs
-        uses: mhausenblas/mkdocs-deploy-gh-pages@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          CONFIG_FILE: mkdocs.yml
-          REQUIREMENTS: requirements.txt
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - run: pip install mkdocs-material
+      - run: pip install -r requirements.txt
+
+      - run: mkdocs gh-deploy --force

.github/workflows/release.yml

@@ -5,7 +5,7 @@ on:
     tags:
       - '*'
   pull_request:
-    
+
 permissions:
   contents: write
   packages: write
@@ -21,7 +21,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - 
+      -
         uses: actions/setup-go@v5
         with:
           go-version: '1.21'
@@ -59,4 +59,4 @@ jobs:
           version: latest
           args: release --skip=publish --skip=validate
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      
+
       - run: go generate -tags tools tools/tools.go
 
       - uses: actions/setup-go@v5

.gitignore

@@ -8,4 +8,4 @@ coverage.out
 .vscode/
 manpages/
 completions/
-dist/
+dist/

.golang-ci.yml

@@ -30,4 +30,4 @@ linters:
     - tagalign
     - copyloopvar
     - intrange
-    - execinquery
+    - execinquery

.goreleaser.yml

@@ -18,7 +18,7 @@ builds:
     goarch:
       - amd64
       - arm64
-      
+
 archives:
   -
     builds:
@@ -141,4 +141,4 @@ changelog:
       regexp: ^.*?doc(\([[:word:]]+\))??!?:.+$
       order: 400
     - title: Other work
-      order: 9999
+      order: 9999

.pre-commit-config.yaml

@@ -1,19 +1,16 @@
 repos:
-  - repo: https://github.com/tekwizely/pre-commit-golang
-    rev: v1.0.0-rc.1
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
     hooks:
-      - id: go-build-mod
-      - id: go-test-mod
-      - id: go-vet-mod
-      - id: go-staticcheck-mod
-      - id: go-fmt
-      - id: go-fumpt
-      - id: go-imports
-      - id: go-lint
-      - id: golangci-lint-mod
-        args: [-c.golang-ci.yml]
-
-  - repo: https://github.com/hadolint/hadolint
-    rev: v2.12.0
-    hooks:
-      - id: hadolint
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-case-conflict
+      - id: check-symlinks
+      - id: check-json
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
+      - id: no-commit-to-branch
+        args: [--branch, main]
+      - id: pretty-format-json
+        args: [--autofix, --no-sort-keys]

Dockerfile.goreleaser

@@ -7,4 +7,4 @@ EXPOSE 8080
 # preinstall vault for VKV_LOGIN_COMMAND
 RUN apk add --no-cache bash vault libcap && setcap -r /usr/sbin/vault
 
-ENTRYPOINT ["/usr/bin/vkv"]
+ENTRYPOINT ["/usr/bin/vkv"]

Makefile

@@ -86,4 +86,4 @@ docs: ## build and serve docs
 .PHONY: docgen
 docgen:
 	go run main.go docs
-	find ./docs -name '*.md' -print0 | xargs -0 sed -i 's/```vkv/```go/g'
+	find ./docs -name '*.md' -print0 | xargs -0 sed -i 's/```vkv/```go/g'

README.md

@@ -54,14 +54,14 @@ secret/ [desc=key/value secret storage] [type=kv2] # engine description & type
 ├── demo [v=1]
 │   └── foo=***
 └── sub
-    ├── demo [v=1] 
+    ├── demo [v=1]
     │   ├── demo=***********
     │   ├── password=******
     │   └── user=*****
     └── sub2
-        └── demo [v=2] [admin=false key=value] 
+        └── demo [v=2] [admin=false key=value]
             ├── admin=***
             ├── foo=***
             ├── password=********
             └── user=****
-```
+```

assets/tapes/demo.tape

@@ -21,4 +21,4 @@ Up
 Sleep 2
 
 Down
-Sleep 2
+Sleep 2

assets/tapes/diff.tape

@@ -7,4 +7,4 @@ Set Height 1000
 Show
 Type "diff -ty <(vkv export -p secret --show-values) <(vkv export -p secret_2 --show-values)"
 Enter
-Sleep 5s
+Sleep 5s

assets/tapes/fzf.tape

@@ -13,4 +13,4 @@ Up
 Sleep 2
 
 Down
-Sleep 2
+Sleep 2

cmd/root_test.go

@@ -67,7 +67,7 @@ func (s *VaultSuite) TestMode() {
 			expected: `e2e/ [type=kv2]
 ├── sub [v=1]
 │   └── user=********
-│   
+│
 └── sub2 [v=1]
     └── key=*****
 `,

cmd/testdata/secret.yaml

@@ -21,4 +21,4 @@
       }
     }
   }
-}
+}

docs/authentication.md

@@ -1,13 +1,13 @@
 # Authentication
 
-`vkv` supports all of Vaults [environment variables](https://www.vaultproject.io/docs/commands#environment-variables) as well as any configured [Token helpers](https://developer.hashicorp.com/vault/docs/commands/token-helper). 
+`vkv` supports all of Vaults [environment variables](https://www.vaultproject.io/docs/commands#environment-variables) as well as any configured [Token helpers](https://developer.hashicorp.com/vault/docs/commands/token-helper).
 
 In order to authenticate you will have to set at least one of the `VAULT_ADDR` or `VKV_LOGIN_COMMAND` and `VAULT_TOKEN` env vars.
 
 ## MacOS/Linux
 ```
 export VAULT_ADDR="http://127.0.0.1:8200"
-export VAULT_TOKEN="hvs.XXX" 
+export VAULT_TOKEN="hvs.XXX"
 vkv export --path <KVv2-path>
 ```
 

docs/cicd_azure.md

@@ -28,4 +28,4 @@ steps:
       eval $(curl http://vkv:8080)
       echo $secret
     displayName: Read secrets as env vars using vkv
-```
+```

docs/cicd_github.md

@@ -25,4 +25,4 @@ jobs:
         run: eval $(curl http://vkv:8080/export)
       - name: output secrets now available as env vars
         run: echo $secret
-```
+```

docs/cicd_gitlab.md

@@ -24,8 +24,8 @@ default:
       command: ["server"]
       alias: vkv
   # global before_scripts block
-  before_script: 
-    # install curl, or wget in your job container   
+  before_script:
+    # install curl, or wget in your job container
     - apk add --no-cache curl
 
     # curl/wget vkv on /export, which will expot all secrets from VKV_SERVER_PATH, eval the output into your shell
@@ -42,5 +42,5 @@ default:
 test:
   stage: test
   script:
-    - make test 
+    - make test
 ```

docs/configuration.md

@@ -18,8 +18,8 @@ example:
 ```bash
 VKV_EXPORT_PATH=secret VKV_MODE=export vkv
 secret/
-├── v1: admin [key=value]   
-│   └── sub=********        
+├── v1: admin [key=value]
+│   └── sub=********
 ├── v1: demo
 │   └── foo=***
 └── sub/
@@ -66,4 +66,4 @@ Simply run:
 
 ```bash
 man vkv
-```
+```

docs/development.md

@@ -41,4 +41,4 @@ secret/ [desc=key/value secret storage] [type=kv2]
             ├── foo=***
             ├── password=********
             └── user=****
-```
+```

docs/example_direnv.md

@@ -14,7 +14,7 @@ export VAULT_TOKEN="$(cat ~/.vault-token)"
 eval $(vkv export -p kv/secrets -f export)
 ```
 
-Now if you go into that directory and run `direnv allow`, 
+Now if you go into that directory and run `direnv allow`,
 you have the secrets under `kv/secrets` exported as env various:
 
 ```bash

docs/example_fzf.md

@@ -1,6 +1,6 @@
 # fzf
 
-using `vault secrets list` and a little bit of `jq`-logic, we can get a list of all KV-engines visible for the token. 
+using `vault secrets list` and a little bit of `jq`-logic, we can get a list of all KV-engines visible for the token.
 
 If we pipe this into `fzf` we can get a handy little  preview-app:
 

docs/example_kubernetes.md

@@ -1,6 +1,6 @@
 # Kubernetes
 
-`vkv` comes in container images, which enable you to run scheduled snapshots in a kubernetes cluster. 
+`vkv` comes in container images, which enable you to run scheduled snapshots in a kubernetes cluster.
 
 The idea is to schedule a cronjob which snapshots a vault server and writes the snapshot files to a persistent volume.
 
@@ -82,7 +82,7 @@ spec:
               - name: VAULT_TOKEN
                 value: hvs.xxxx # change to your token
             volumeMounts:
-              - name: local-persistent-storage 
+              - name: local-persistent-storage
                 mountPath: /mnt
           restartPolicy: OnFailure
           volumes:
@@ -109,4 +109,4 @@ Obviously this approach is just for development purposes. In order to make it pr
 * Or obtain the token using Vaults kubernetes auth engine and the [Vault Agent injector](https://developer.hashicorp.com/vault/docs/platform/k8s/injector)
 * run the cronjob daily
 * update the permission of the volumes
-* backup the pv
+* backup the pv

docs/example_migrate_kvv1_kvv2.md

@@ -17,7 +17,7 @@ $> vkv export -p kvv1 -f=json | vkv import -p kv
 v2
 reading secrets from STDIN
 parsing secrets from JSON
-writing secret "kvv2/dev" 
+writing secret "kvv2/dev"
 successfully imported all secrets
 
 result:
@@ -37,10 +37,10 @@ kvv2/
 You can also move a KV mount within another engine:
 
 ```bash
-$> vkv export -p kvv1 -f=json | vkv import -p engine/subpath --force 
+$> vkv export -p kvv1 -f=json | vkv import -p engine/subpath --force
 reading secrets from STDIN
 parsing secrets from JSON
-writing secret "engine/subpath/dev" 
+writing secret "engine/subpath/dev"
 successfully imported all secrets
 
 result:
@@ -57,4 +57,4 @@ engine/
     └── dev [v=1]
         ├── admin=****
         └── password=**
-```
+```

docs/example_sops.md

@@ -67,4 +67,4 @@ sops:
     pgp: []
     unencrypted_suffix: _unencrypted
     version: 3.7.3
-```
+```