Skip to content

Generate docs for 0.44.x version #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Generate docs for 0.44.x version #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e05ae3
chore: empty commit for 0.44.x version
github-actions[bot] Aug 5, 2026
cd5f9f0
Update docs for 0.44.4
r3nic1e Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/examples/apps-per-ns/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ repositories:

# General options
.options: &options
wait: true
wait: watcher
wait_for_jobs: true
force: false
timeout: 10m
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/apps-per-ns/helmwave.yml.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ repositories:

# General options
.options: &options
wait: true
wait: watcher
wait_for_jobs: true
force: false
timeout: 10m
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/cross-release-reference/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ repositories:

.options: &options
namespace: my-namespace
wait: true
wait: watcher

releases:
# redis is built first (no dependencies)
Expand Down
6 changes: 4 additions & 2 deletions docs/examples/full/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,13 @@ releases:
disable_hooks: false
disable_openapi_validation: false
force: false
force_conflicts: false
server_side_apply: auto
post_render_strategy: combined
enable_dns: false
recreate: false
reset_values: false
reuse_values: false
skip_crds: false
sub_notes: false
wait: true
wait: watcher
wait_for_jobs: true
2 changes: 1 addition & 1 deletion docs/examples/graph/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ registries:
.options: &options
namespace: my-namespace
create_namespace: true
wait: true
wait: watcher
timeout: 1m
max_history: 3 # best practice
offline_kube_version: 1.22.2
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/kubedog/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ releases:
- values.yml
namespace: my-redis
create_namespace: true
wait: true
wait: watcher
timeout: 3m
2 changes: 1 addition & 1 deletion docs/examples/lifecycle/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ registries:
namespace: my-namespace
create_namespace: true
offline_kube_version: 1.22.0
wait: true
wait: watcher
timeout: 1m
max_history: 3 # best practice
chart:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/monitors/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ monitors:
.options: &options
namespace: nats
create_namespace: true
wait: true
wait: watcher
timeout: 1m
max_history: 3 # best practice
chart:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/private-github-repo/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ repositories:
.options: &options
namespace: ips
create_namespace: true
wait: true
wait: watcher

releases:
- name: hello
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/private-github-repo/helmwave.yml.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ repositories:
.options: &options
namespace: {{ requiredEnv "NS" }}
create_namespace: true
wait: true
wait: watcher


releases:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/quick-start/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ registries:
.options: &options
namespace: my-namespace
create_namespace: true
wait: true
wait: watcher
timeout: 1m
max_history: 3 # best practice
chart:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/umbrella-evil/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ repositories:

.options: &options
namespace: stage
wait: true
wait: watcher
max_history: 5

releases:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/values-delimiter-flags/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ repositories:

.options: &options
namespace: my-namespace
wait: true
wait: watcher

releases:
- name: nginx
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/values-dependencies/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ repositories:

.options: &options
namespace: my-namespace
wait: true
wait: watcher

releases:
- name: nginx
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/values-disable-render/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ repositories:

.options: &options
namespace: my-namespace
wait: true
wait: watcher

releases:
- name: nginx
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/values-sops/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ repositories:

.options: &options
namespace: my-namespace
wait: true
wait: watcher

releases:
- name: nginx
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/values-strict-flag/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ repositories:

.options: &options
namespace: my-namespace
wait: true
wait: watcher

releases:
- name: nginx
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/vault/helmwave.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ releases:
- name: app
chart: bitnami/nginx
namespace: test
wait: true
wait: watcher
values:
- values-secret.yaml
53 changes: 45 additions & 8 deletions docs/yaml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ Almost all options that are here are native :simple-helm: helm options.
| monitors | 🙅 | array | [] | ✅ | |
| allow_failure | 🙅 | bool | false | | |
| pending_release_strategy | 🙅 | string | "" | | |
| wait | 🙅 | bool | false | | :simple-helm: |
| wait | 🙅 | string | "hookOnly" | | :simple-helm: |
| wait_for_jobs | 🙅 | bool | false | | :simple-helm: |
| timeout | 🙅 | interval | 5m | | :simple-helm: |
| max_history | 🙅 | int | 0 | | :simple-helm: |
Expand All @@ -359,17 +359,19 @@ Almost all options that are here are native :simple-helm: helm options.
| disable_hooks | 🙅 | bool | false | | :simple-helm: |
| disable_open_api_validation | 🙅 | bool | false | | :simple-helm: |
| force | 🙅 | bool | false | | :simple-helm: |
| force_conflicts | 🙅 | bool | false | | :simple-helm: |
| enable_dns | 🙅 | bool | false | | :simple-helm: |
| recreate | 🙅 | bool | false | | :simple-helm: |
| reset_values | 🙅 | bool | false | | :simple-helm: |
| reuse_values | 🙅 | bool | false | | :simple-helm: |
| reset_then_reuse_values | 🙅 | bool | false | | :simple-helm: |
| skip_crds | 🙅 | bool | false | | :simple-helm: |
| take_ownership | 🙅 | bool | false | | :simple-helm: |
| skip_schema_validation | 🙅 | bool | false | | :simple-helm: |
| server_side_apply | 🙅 | string | "auto" | | :simple-helm: |
| hide_notes | 🙅 | bool | true | | :simple-helm: |
| sub_notes | 🙅 | bool | false | | :simple-helm: |
| post_renderer | 🙅 | array | [] | ✅ | :simple-helm: |
| post_render_strategy | 🙅 | string | "combined" | | :simple-helm: |
| delete_propagation | 🙅 | string | "background" | | :simple-helm: |
| labels | 🙅 | object | {} | | :simple-helm: |
| tests | 🙅 | object | {} | | :simple-helm: |
Expand Down Expand Up @@ -757,7 +759,19 @@ it will follow specified strategy:

### wait

We recommend using `wait` for all releases. It will wait for all resources to be ready.
> Changed in [:material-tag: v0.44.4](https://github.com/helmwave/helmwave/releases/tag/v0.44.4)

How to wait for the release resources:

- `watcher` — wait for every resource using kubernetes watches;
- `legacy` — wait by polling;
- `hookOnly` (default) — wait only for hooks, not for the chart's own resources.

We recommend `watcher` for all releases.

!!! danger "The booleans are gone since v0.44.4"

`wait: true` and `wait: false` are rejected: use `watcher` instead of `true` and `hookOnly` instead of `false`.

### wait_for_jobs

Expand Down Expand Up @@ -836,6 +850,12 @@ Force resource updates through a replacement strategy

!!! tip "We don't recommend using this option."

### force_conflicts

> Introduced in [:material-tag: v0.44.4](https://github.com/helmwave/helmwave/releases/tag/v0.44.4)

Force [server-side apply](#server_side_apply) changes against field-ownership conflicts.

### enable_dns

> Introduced in [:material-tag: v0.27.1](https://github.com/helmwave/helmwave/releases/tag/v0.27.1)
Expand All @@ -844,11 +864,8 @@ Enable DNS resolution in templates.

### recreate

> Introduced in [:material-tag: v0.5.0](https://github.com/helmwave/helmwave/releases/tag/v0.5.0)

Allows deleting and then creating resources (pods) when needed instead of updating.

!!! tip "We don't recommend using this option."
> Removed in [:material-tag: v0.44.4](https://github.com/helmwave/helmwave/releases/tag/v0.44.4) — helm v4
> removed the option behind it. The key is still parsed but has no effect.

### reset_values

Expand Down Expand Up @@ -903,6 +920,12 @@ Will ignore the check for helm annotations and take ownership of the resources

Determines if JSON schema validation is disabled

### server_side_apply

> Introduced in [:material-tag: v0.44.4](https://github.com/helmwave/helmwave/releases/tag/v0.44.4)

Whether to apply objects server-side: `true`, `false` or `auto` (default).

### post_renderer

> Introduced in [:material-tag: v0.24.0](https://github.com/helmwave/helmwave/releases/tag/v0.24.0)
Expand All @@ -911,6 +934,20 @@ You can use custom commands to change rendered manifests.

Check out [:material-duck: the example](../examples/helm-patch-with-kustomize)

!!! note "Since v0.44.4 the command also receives hook manifests by default"

Set [`post_render_strategy: nohooks`](#post_render_strategy) to feed it manifests only.

### post_render_strategy

> Introduced in [:material-tag: v0.44.4](https://github.com/helmwave/helmwave/releases/tag/v0.44.4)

How manifests are handed to the [`post_renderer`](#post_renderer):

- `combined` (default) — templates and hooks in one stream;
- `separate` — templates and hooks in separate runs;
- `nohooks` — templates only.

### hide_notes (ex:show_notes)

> Introduced in [:material-tag: v0.31.0](https://github.com/helmwave/helmwave/releases/tag/v0.31.0)
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ theme:
- search.highlight

extra:
ver: 0.43.0
ver: 0.44.4
version:
provider: mike
default: latest
Expand Down
Loading