Skip to content

Commit 88b9e8c

Browse files
committed
Deploying to gh-pages from @ bed7d8c 🚀
1 parent f2d901d commit 88b9e8c

File tree

4 files changed

+22
-16
lines changed

4 files changed

+22
-16
lines changed

print.html

+10-7
Original file line numberDiff line numberDiff line change
@@ -301,8 +301,8 @@ <h2 id="helm_package"><a class="header" href="#helm_package">helm_package</a></h
301301
<pre>
302302
load("@rules_helm//helm:defs.bzl", "helm_package")
303303

304-
helm_package(<a href="rules.html#helm_package-name">name</a>, <a href="rules.html#helm_package-deps">deps</a>, <a href="rules.html#helm_package-chart">chart</a>, <a href="rules.html#helm_package-chart_json">chart_json</a>, <a href="rules.html#helm_package-crds">crds</a>, <a href="rules.html#helm_package-images">images</a>, <a href="rules.html#helm_package-stamp">stamp</a>, <a href="rules.html#helm_package-substitutions">substitutions</a>, <a href="rules.html#helm_package-templates">templates</a>, <a href="rules.html#helm_package-values">values</a>,
305-
<a href="rules.html#helm_package-values_json">values_json</a>)
304+
helm_package(<a href="rules.html#helm_package-name">name</a>, <a href="rules.html#helm_package-deps">deps</a>, <a href="rules.html#helm_package-chart">chart</a>, <a href="rules.html#helm_package-chart_json">chart_json</a>, <a href="rules.html#helm_package-crds">crds</a>, <a href="rules.html#helm_package-files">files</a>, <a href="rules.html#helm_package-images">images</a>, <a href="rules.html#helm_package-stamp">stamp</a>, <a href="rules.html#helm_package-substitutions">substitutions</a>, <a href="rules.html#helm_package-templates">templates</a>,
305+
<a href="rules.html#helm_package-values">values</a>, <a href="rules.html#helm_package-values_json">values_json</a>)
306306
</pre>
307307
<p>Rules for creating Helm chart packages.</p>
308308
<p><strong>ATTRIBUTES</strong></p>
@@ -311,7 +311,8 @@ <h2 id="helm_package"><a class="header" href="#helm_package">helm_package</a></h
311311
<tr><td style="text-align: left"><a id="helm_package-deps"></a>deps</td><td style="text-align: left">Other helm packages this package depends on.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">List of labels</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
312312
<tr><td style="text-align: left"><a id="helm_package-chart"></a>chart</td><td style="text-align: left">The <code>Chart.yaml</code> file of the helm chart</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">Label</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr>
313313
<tr><td style="text-align: left"><a id="helm_package-chart_json"></a>chart_json</td><td style="text-align: left">The <code>Chart.yaml</code> file of the helm chart as a json object</td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>""</code></td></tr>
314-
<tr><td style="text-align: left"><a id="helm_package-crds"></a>crds</td><td style="text-align: left">All crds associated with the current helm chart. E.g., the <code>./crds</code> directory</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">List of labels</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
314+
<tr><td style="text-align: left"><a id="helm_package-crds"></a>crds</td><td style="text-align: left">All <a href="https://helm.sh/docs/chart_best_practices/custom_resource_definitions/">Custom Resource Definitions</a> associated with the current helm chart. E.g., the <code>./crds</code> directory</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">List of labels</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
315+
<tr><td style="text-align: left"><a id="helm_package-files"></a>files</td><td style="text-align: left">Files accessed in templates via the <a href="https://helm.sh/docs/chart_template_guide/accessing_files/"><code>.Files</code> api</a></td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">List of labels</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
315316
<tr><td style="text-align: left"><a id="helm_package-images"></a>images</td><td style="text-align: left">A list of <a href="https://github.com/bazel-contrib/rules_oci/blob/main/docs/push.md#oci_push_rule-remote_tags">oci_push</a> targets.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">List of labels</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
316317
<tr><td style="text-align: left"><a id="helm_package-stamp"></a>stamp</td><td style="text-align: left">Whether to encode build information into the helm actions. Possible values:<br><br>- <code>stamp = 1</code>: Always stamp the build information into the helm actions, even in <a href="https://docs.bazel.build/versions/main/user-manual.html#flag--stamp">--nostamp</a> builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it.<br><br>- <code>stamp = 0</code>: Always replace build information by constant values. This gives good build result caching.<br><br>- <code>stamp = -1</code>: Embedding of build information is controlled by the <a href="https://docs.bazel.build/versions/main/user-manual.html#flag--stamp">--[no]stamp</a> flag.<br><br>Stamped targets are not rebuilt unless their dependencies change.</td><td style="text-align: left">Integer</td><td style="text-align: left">optional</td><td style="text-align: left"><code>-1</code></td></tr>
317318
<tr><td style="text-align: left"><a id="helm_package-substitutions"></a>substitutions</td><td style="text-align: left">A dictionary of substitutions to apply to the <code>values.yaml</code> file.</td><td style="text-align: left"><a href="https://bazel.build/rules/lib/dict">Dictionary: String -&gt; String</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>{}</code></td></tr>
@@ -404,14 +405,15 @@ <h2 id="helm_template_test"><a class="header" href="#helm_template_test">helm_te
404405
<pre>
405406
load("@rules_helm//helm:defs.bzl", "helm_template_test")
406407

407-
helm_template_test(<a href="rules.html#helm_template_test-name">name</a>, <a href="rules.html#helm_template_test-chart">chart</a>, <a href="rules.html#helm_template_test-installer">installer</a>)
408+
helm_template_test(<a href="rules.html#helm_template_test-name">name</a>, <a href="rules.html#helm_template_test-chart">chart</a>, <a href="rules.html#helm_template_test-installer">installer</a>, <a href="rules.html#helm_template_test-template_patterns">template_patterns</a>)
408409
</pre>
409410
<p>A test rule for rendering helm chart templates.</p>
410411
<p><strong>ATTRIBUTES</strong></p>
411412
<div class="table-wrapper"><table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Type</th><th style="text-align: left">Mandatory</th><th style="text-align: left">Default</th></tr></thead><tbody>
412413
<tr><td style="text-align: left"><a id="helm_template_test-name"></a>name</td><td style="text-align: left">A unique name for this target.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels#target-names">Name</a></td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
413414
<tr><td style="text-align: left"><a id="helm_template_test-chart"></a>chart</td><td style="text-align: left">The helm package to resolve templates for. Mutually exclusive with <code>installer</code>.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">Label</a></td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
414415
<tr><td style="text-align: left"><a id="helm_template_test-installer"></a>installer</td><td style="text-align: left">The <code>helm_install</code>/<code>helm_upgrade</code> target to resolve templates for. Mutually exclusive with <code>chart</code>.</td><td style="text-align: left"><a href="https://bazel.build/concepts/labels">Label</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>None</code></td></tr>
416+
<tr><td style="text-align: left"><a id="helm_template_test-template_patterns"></a>template_patterns</td><td style="text-align: left">A mapping of template paths to regex patterns required to match.</td><td style="text-align: left"><a href="https://bazel.build/rules/lib/dict">Dictionary: String -&gt; List of strings</a></td><td style="text-align: left">optional</td><td style="text-align: left"><code>{}</code></td></tr>
415417
</tbody></table>
416418
</div>
417419
<p><a id="helm_toolchain"></a></p>
@@ -504,8 +506,8 @@ <h2 id="helm_chart"><a class="header" href="#helm_chart">helm_chart</a></h2>
504506
<pre>
505507
load("@rules_helm//helm:defs.bzl", "helm_chart")
506508

507-
helm_chart(<a href="rules.html#helm_chart-name">name</a>, <a href="rules.html#helm_chart-chart">chart</a>, <a href="rules.html#helm_chart-chart_json">chart_json</a>, <a href="rules.html#helm_chart-crds">crds</a>, <a href="rules.html#helm_chart-values">values</a>, <a href="rules.html#helm_chart-values_json">values_json</a>, <a href="rules.html#helm_chart-substitutions">substitutions</a>, <a href="rules.html#helm_chart-templates">templates</a>, <a href="rules.html#helm_chart-images">images</a>,
508-
<a href="rules.html#helm_chart-deps">deps</a>, <a href="rules.html#helm_chart-install_name">install_name</a>, <a href="rules.html#helm_chart-registry_url">registry_url</a>, <a href="rules.html#helm_chart-login_url">login_url</a>, <a href="rules.html#helm_chart-helm_opts">helm_opts</a>, <a href="rules.html#helm_chart-install_opts">install_opts</a>, <a href="rules.html#helm_chart-upgrade_opts">upgrade_opts</a>,
509+
helm_chart(*, <a href="rules.html#helm_chart-name">name</a>, <a href="rules.html#helm_chart-chart">chart</a>, <a href="rules.html#helm_chart-chart_json">chart_json</a>, <a href="rules.html#helm_chart-crds">crds</a>, <a href="rules.html#helm_chart-values">values</a>, <a href="rules.html#helm_chart-values_json">values_json</a>, <a href="rules.html#helm_chart-substitutions">substitutions</a>, <a href="rules.html#helm_chart-templates">templates</a>, <a href="rules.html#helm_chart-files">files</a>,
510+
<a href="rules.html#helm_chart-images">images</a>, <a href="rules.html#helm_chart-deps">deps</a>, <a href="rules.html#helm_chart-install_name">install_name</a>, <a href="rules.html#helm_chart-registry_url">registry_url</a>, <a href="rules.html#helm_chart-login_url">login_url</a>, <a href="rules.html#helm_chart-helm_opts">helm_opts</a>, <a href="rules.html#helm_chart-install_opts">install_opts</a>, <a href="rules.html#helm_chart-upgrade_opts">upgrade_opts</a>,
509511
<a href="rules.html#helm_chart-uninstall_opts">uninstall_opts</a>, <a href="rules.html#helm_chart-data">data</a>, <a href="rules.html#helm_chart-stamp">stamp</a>, <a href="rules.html#helm_chart-kwargs">**kwargs</a>)
510512
</pre>
511513
<p>Rules for producing a helm package and some convenience targets.</p>
@@ -529,6 +531,7 @@ <h2 id="helm_chart"><a class="header" href="#helm_chart">helm_chart</a></h2>
529531
<tr><td style="text-align: left"><a id="helm_chart-values_json"></a>values_json</td><td style="text-align: left">The json encoded contents of <code>values.yaml</code>.</td><td style="text-align: left"><code>None</code></td></tr>
530532
<tr><td style="text-align: left"><a id="helm_chart-substitutions"></a>substitutions</td><td style="text-align: left">A dictionary of substitutions to apply to <code>values.yaml</code>.</td><td style="text-align: left"><code>{}</code></td></tr>
531533
<tr><td style="text-align: left"><a id="helm_chart-templates"></a>templates</td><td style="text-align: left">A list of template files to include in the package.</td><td style="text-align: left"><code>None</code></td></tr>
534+
<tr><td style="text-align: left"><a id="helm_chart-files"></a>files</td><td style="text-align: left">Files accessed in templates via the <a href="https://helm.sh/docs/chart_template_guide/accessing_files/"><code>.Files</code> api</a>.</td><td style="text-align: left"><code>[]</code></td></tr>
532535
<tr><td style="text-align: left"><a id="helm_chart-images"></a>images</td><td style="text-align: left">A list of <a href="https://github.com/bazel-contrib/rules_oci/blob/main/docs/push.md#oci_push_rule-remote_tags">oci_push</a> targets</td><td style="text-align: left"><code>[]</code></td></tr>
533536
<tr><td style="text-align: left"><a id="helm_chart-deps"></a>deps</td><td style="text-align: left">A list of helm package dependencies.</td><td style="text-align: left"><code>None</code></td></tr>
534537
<tr><td style="text-align: left"><a id="helm_chart-install_name"></a>install_name</td><td style="text-align: left">The <code>helm install</code> name to use. <code>name</code> will be used if unset.</td><td style="text-align: left"><code>None</code></td></tr>
@@ -538,7 +541,7 @@ <h2 id="helm_chart"><a class="header" href="#helm_chart">helm_chart</a></h2>
538541
<tr><td style="text-align: left"><a id="helm_chart-install_opts"></a>install_opts</td><td style="text-align: left">Additional options to pass to <code>helm install</code>.</td><td style="text-align: left"><code>[]</code></td></tr>
539542
<tr><td style="text-align: left"><a id="helm_chart-upgrade_opts"></a>upgrade_opts</td><td style="text-align: left">Additional options to pass to <code>helm upgrade</code>.</td><td style="text-align: left"><code>[]</code></td></tr>
540543
<tr><td style="text-align: left"><a id="helm_chart-uninstall_opts"></a>uninstall_opts</td><td style="text-align: left">Additional options to pass to <code>helm uninstall</code>.</td><td style="text-align: left"><code>[]</code></td></tr>
541-
<tr><td style="text-align: left"><a id="helm_chart-data"></a>data</td><td style="text-align: left">Additional runtime data to pass to the helm templates.</td><td style="text-align: left"><code>[]</code></td></tr>
544+
<tr><td style="text-align: left"><a id="helm_chart-data"></a>data</td><td style="text-align: left">Additional runtime data to pass to the helm install, upgrade, and uninstall targets.</td><td style="text-align: left"><code>[]</code></td></tr>
542545
<tr><td style="text-align: left"><a id="helm_chart-stamp"></a>stamp</td><td style="text-align: left">Whether to encode build information into the helm chart.</td><td style="text-align: left"><code>None</code></td></tr>
543546
<tr><td style="text-align: left"><a id="helm_chart-kwargs"></a>kwargs</td><td style="text-align: left">Additional keyword arguments for <code>helm_package</code>.</td><td style="text-align: left">none</td></tr>
544547
</tbody></table>

0 commit comments

Comments
 (0)