Merge pull request #74 from helmwave/0.33.x

Generate docs for 0.33.x version
helmwave · Dec 4, 2023 · 52e7430 · 52e7430
2 parents dd3d939 + d574f1e
commit 52e7430
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 11 deletions.
diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml
@@ -1,6 +1,9 @@
 on:
   push:
 
+permissions:
+  contents: read
+
 name: linter
 jobs:
   linkinator:

diff --git a/.github/workflows/publish-b.yml b/.github/workflows/publish-b.yml
@@ -11,14 +11,19 @@ on:
         type: boolean
         default: true
 
+permissions:
+  contents: write
+
 jobs:
   upload:
     runs-on: ubuntu-latest
     steps:
       - uses: helmwave/[email protected]
         with:
-          version: '0.32.1'
+          version: '0.33.0'
+
       - run: helmwave schema > schema.json
+
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0

diff --git a/docs/cli.md b/docs/cli.md
@@ -63,8 +63,8 @@ A plan includes:
 {% include "./flags/tags.md" %}
 {% include "./flags/match-all-tags.md" %}
 {% include "./flags/skip-unchanged.md" %}
-{% include "./flags/charts-cache-dir.md" %}
 {% include "./flags/graph-width.md" %}
+{% include "./flags/remote-source.md" %}
 ---
 {% include "./flags/diff-mode.md" %}
 {% include "./flags/wide.md" %}
@@ -362,6 +362,7 @@ Global flags available in any command.
 
 > Helmwave uses [:simple-github: sirupsen/logrus](https://github.com/sirupsen/logrus) as internal logger.
 
+{% include "./flags/cache-dir.md" %}
 {% include "./flags/log-format.md" %}
 {% include "./flags/log-level.md" %}
 {% include "./flags/log-color.md" %}

diff --git a/docs/examples/private-env/README.md b/docs/examples/private-env/README.md
@@ -14,8 +14,6 @@ export HELMWAVE_DIFF_MODE=none
 
 **build a plan**
 
-you can also use `--charts-cache-dir`.
-
 ```shell
 helmwave build
 ```

diff --git a/docs/flags/cache-dir.md b/docs/flags/cache-dir.md
@@ -0,0 +1,6 @@
+### `--cache-dir`
+
+> Introduced in [:material-tag: v0.33.0](https://github.com/helmwave/helmwave/releases/tag/v0.33.0)
+
+
+The directory to use for storing remote sources.
diff --git a/docs/flags/charts-cache-dir.md b/docs/flags/charts-cache-dir.md
diff --git a/docs/flags/remote-source.md b/docs/flags/remote-source.md
@@ -0,0 +1,7 @@
+### `--remote-source`
+
+> Introduced in [:material-tag: v0.33.0](https://github.com/helmwave/helmwave/releases/tag/v0.33.0)
+
+
+Remote source to use for building plan. [go-getter URL format](https://github.com/hashicorp/go-getter#url-format) is used.
+The downloaded remote source is cached and the cache is reused.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -114,7 +114,7 @@ theme:
     - search.highlight
 
 extra:
-  ver: 0.32.1
+  ver: 0.33.0
   version:
     provider: mike
     default: latest