Add frank-gateway Helm chart wrapping the official apisix chart - #39
Add frank-gateway Helm chart wrapping the official apisix chart#39jjansenvr wants to merge 3 commits into
Conversation
Wraps apache/apisix-helm-chart 2.14.0 as a dependency with our own defaults: standalone/yaml deployment mode, no etcd/ingress-controller, custom GHCR image. Includes a weekly GH Action that checks for new apisix chart releases and opens a PR to bump the dependency. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds a new frank-gateway Helm chart that wraps the upstream apache/apisix-helm-chart as a dependency and provides opinionated defaults for running APISIX in standalone/YAML mode, plus automation to detect and propose dependency bumps.
Changes:
- Introduces
charts/frank-gatewayas a wrapper chart depending onapisixchart2.14.0. - Sets default subchart overrides for standalone/YAML mode, disables etcd and ingress-controller, and configures a custom GHCR image.
- Adds a scheduled GitHub Actions workflow to check for new APISIX chart releases and open an automated bump PR.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| charts/frank-gateway/values.yaml | Adds default apisix subchart overrides (standalone/YAML mode, no etcd/ingress-controller, custom image). |
| charts/frank-gateway/readme.md | Documents dependency-update troubleshooting and value nesting gotchas. |
| charts/frank-gateway/Chart.yaml | Defines the new wrapper chart and pins the apisix chart dependency. |
| charts/frank-gateway/Chart.lock | Locks the dependency resolution for the pinned apisix chart. |
| .github/workflows/check-apisix-update.yaml | Adds weekly automation to detect new apisix chart versions and open a bump PR. |
Suppressed comments (1)
charts/frank-gateway/readme.md:17
- De README verwijst naar
./scripts/update-deps.sh, maar dat script bestaat nergens in deze repository. Dat maakt de troubleshooting-instructie onbruikbaar/verwarrend; ofwel het script toevoegen, of de verwijzing verwijderen.
Of draai `./scripts/update-deps.sh`, die dit automatisch afhandelt.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Rename readme.md -> README.md to match this repo's chart convention. - Drop dead reference to a non-existent ./scripts/update-deps.sh. - Pin azure/setup-helm and yq to specific versions instead of latest, avoiding unreviewed breaking changes in the weekly update workflow. - Make charts.apiseven.com the primary apisix dependency repo instead of apache.github.io: the shared release.yml runs `helm dependency update` for every chart with no fallback logic, so DNS flakiness on the ASF domain could block releases for the whole repo, not just this chart. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
| working-directory: charts/frank-gateway | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 |
There was a problem hiding this comment.
All GitHub actions should be pinned on commit hash instead of tag. This is to harden against supply-chain attacks. Tags can be overwritten with malicious code; Commit hashes are immutable.
philipsens
left a comment
philipsens
left a comment
There was a problem hiding this comment.
The chart looks fine. It sets few default so people can configure it further themselves.
For documentation we use the readme-generator-for-helm, which will add the documentation to the README that is visible on GitHub and the GitHub Pages. You could look at Frank2Example values.yaml for an example.
Wraps apache/apisix-helm-chart 2.14.0 as a dependency with our own defaults: standalone/yaml deployment mode, no etcd/ingress-controller, custom GHCR image. Includes a weekly GH Action that checks for new apisix chart releases and opens a PR to bump the dependency.