Skip to content

gotify-v1.0.1

Latest
Latest

Choose a tag to compare

View all tags
@github-actions github-actions released this 02 Mar 05:43
· 4 commits to main since this release
gotify-v1.0.1
bdfc044
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

📖 Chart README: document all inputs from upstream

What Why safe Proof
Add a Configuration reference (all inputs) section to the chart README. Every value accepted by the chart (root and each subchart) is documented in tables: Key, Type, Default, Description. Values are derived from the upstream/parent chart(s) we depend on. Documentation-only change; no chart logic or defaults change. Render unchanged. helm template run below; README not part of render.

Summary

Change Explanation
📖 Configuration reference (all inputs) New README section listing every input: root/chart-specific keys and each subchart's keys (oauth2, reloader, mealie/gotify app-template, onepassworditem, services[]) with type, default, and short description. Sourced from upstream chart values so deployers have one place to see all options.
📖 Subchart tables Each dependency (upstream chart or onepassworditem) gets a table; key paths match the values prefix (e.g. oauth2.*, onepassworditem.*).

Render & validation

From chart directory: helm dependency update . && helm template RELEASE . -f values.yaml -n NAMESPACE

Check Result
Chart renders without error ✅
No values.yaml or template change in this PR ✅ (README only)

Supporting evidence

📋 helm template (excerpt)

Chart renders successfully. Example excerpt (oauth2-proxy):

# Source: oauth2-proxy/charts/oauth2/templates/configmap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: oauth2-proxy
  namespace: edge
data:
  oauth2_proxy.cfg: "provider = \"github\"\nproxy_prefix = \"/oauth2\"\n..."

README is not part of the template output; this PR only adds markdown documentation.

Why each change is safe & correct

Change What we did Why it's safe Proof in render
README: Configuration reference Added section with tables for every input (root + each subchart), keyed to upstream chart sources. Documentation only; no change to Chart.yaml, values.yaml, or templates. N/A (docs); helm template unchanged.

Next steps

  1. Merge PR.
  2. (Optional) After merge, run release-notes workflow to refresh release body.
Assets 3
Loading