Skip to content

ci(helm): add chart release workflows - #113

Merged
hami-robot[bot] merged 9 commits into
Project-HAMi:mainfrom
spencercjh:feat/release-chart
Aug 4, 2026
Merged

ci(helm): add chart release workflows#113
hami-robot[bot] merged 9 commits into
Project-HAMi:mainfrom
spencercjh:feat/release-chart

Conversation

@spencercjh

@spencercjh spencercjh commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Most of this Pull Request was generated or revised with the assistance of AI tools(Codex with GPT-5.6 Sol High). I have reviewed the resulting content and take full responsibility for its accuracy, security, licensing compliance, and inclusion in this project.

Summary

  • add a Helm lint workflow with path filtering and a stable required check
  • publish chart releases to GitHub Pages, GitHub Releases, and GHCR when the chart version changes or the workflow is dispatched manually
  • add Makefile targets for generated chart documentation, values schema generation, linting, and template rendering
  • preserve the existing installation guide while generating the chart metadata and values reference with helm-docs

Validation

  • make verify-helm-chart with Helm v3.20.0
  • actionlint .github/workflows/helm-lint.yaml .github/workflows/build-helm-release.yaml
  • repeated chart documentation and schema generation produced identical outputs
  • git verify-commit HEAD

Notes

  • Helm releases are serialized across refs to avoid concurrent gh-pages updates.
  • The GHCR namespace is normalized to lowercase before pushing the OCI chart.

Summary by CodeRabbit

  • New Features
    • Added comprehensive Helm chart documentation, including installation guidance and configurable values.
    • Added schema-based validation for Helm chart values.
    • Automated Helm chart publishing to GHCR for manual releases, version changes, and version tags.
  • Bug Fixes
    • Added CI verification for generated documentation, schema synchronization, chart linting, rendering, and container arguments.
  • Chores
    • Expanded .gitignore coverage for Linux, Go, macOS, IDE, and worktree artifacts.
    • Added inline documentation for chart configuration values and deployment settings.

@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@spencercjh, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 43 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 3fa98d50-18e8-4d65-803c-e2927505a3f0

📥 Commits

Reviewing files that changed from the base of the PR and between 5ad8c2b and 71adf6d.

📒 Files selected for processing (9)
  • .github/workflows/build-helm-release.yaml
  • .github/workflows/helm-lint.yaml
  • Makefile
  • charts/ascend-device-plugin/Chart.yaml
  • charts/ascend-device-plugin/README.md
  • charts/ascend-device-plugin/values.schema.json
  • charts/ascend-device-plugin/values.yaml
  • docs/volcano.md
  • docs/volcano_cn.md
📝 Walkthrough

Walkthrough

Adds Helm chart documentation and schema generation, pull-request validation, push/manual OCI releases to GHCR, and expanded cross-platform repository ignore rules.

Changes

Helm chart automation

Layer / File(s) Summary
Chart values and documentation
charts/ascend-device-plugin/values.yaml, charts/ascend-device-plugin/values.schema.json, charts/ascend-device-plugin/README.md, charts/ascend-device-plugin/README.md.gotmpl
Adds documented values, a typed JSON schema, generated values reference content, and installation guidance.
Chart verification pipeline
Makefile, .github/workflows/helm-lint.yaml
Adds documentation and schema generation, chart lint and template checks, and pull-request gating for Helm-related changes.
Chart release publication
.github/workflows/build-helm-release.yaml
Adds version-change detection and manual or push-triggered workflows that package the chart and publish versioned OCI artifacts to GHCR.

Repository maintenance

Layer / File(s) Summary
Ignore rule refresh
.gitignore
Adds Linux, Go, macOS, editor, and worktree ignore patterns.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Sequence Diagram(s)

sequenceDiagram
  participant GitHubActions
  participant ChartVersion
  participant HelmChartReleaser
  participant GHCR
  GitHubActions->>ChartVersion: Read current and previous chart versions
  ChartVersion->>GitHubActions: Return version_changed
  GitHubActions->>HelmChartReleaser: Package chart and update gh-pages
  HelmChartReleaser->>GHCR: Check version and push OCI chart
Loading

Possibly related PRs

Suggested labels: enhancement

Suggested reviewers: archlitchi

Poem

A rabbit checks each Helm chart line,
While schemas keep the values fine.
CI verifies every part,
GHCR receives the chart.
New releases hop into the night! 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: adding CI workflows for Helm chart releases.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@hami-robot

hami-robot Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Welcome @spencercjh! It looks like this is your first PR to Project-HAMi/ascend-device-plugin 🎉

@spencercjh

Copy link
Copy Markdown
Contributor Author

/assign archlitchi

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/build-helm-release.yaml:
- Around line 11-20: Add a workflow-level permissions default near the existing
env/concurrency configuration in the Helm release workflow, setting the GitHub
Actions token to read-only (contents: read). Keep the explicit elevated
permissions in release jobs unchanged.

In @.github/workflows/helm-lint.yaml:
- Around line 41-42: Update the actions/checkout step named “Checkout” in the
Helm lint workflow to set persist-credentials to false before make
verify-helm-chart runs, while leaving the existing checkout behavior and local
git diff functionality unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: bec4860b-270d-4dd1-b877-1618e733c8ca

📥 Commits

Reviewing files that changed from the base of the PR and between f8ae57c and 9e01f3c.

📒 Files selected for processing (8)
  • .github/workflows/build-helm-release.yaml
  • .github/workflows/helm-lint.yaml
  • .gitignore
  • Makefile
  • charts/ascend-device-plugin/README.md
  • charts/ascend-device-plugin/README.md.gotmpl
  • charts/ascend-device-plugin/values.schema.json
  • charts/ascend-device-plugin/values.yaml

Comment thread .github/workflows/build-helm-release.yaml
Comment thread .github/workflows/helm-lint.yaml
@spencercjh

spencercjh commented Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

It's almost copied from https://github.com/dynamia-ai/ppu-vgpu-device-plugin

@spencercjh

Copy link
Copy Markdown
Contributor Author

/assign DSFans2014

Comment thread charts/ascend-device-plugin/values.yaml Outdated
@spencercjh
spencercjh force-pushed the feat/release-chart branch 2 times, most recently from e7a3bfb to e97da30 Compare July 16, 2026 02:39
Comment thread .github/workflows/build-helm-release.yaml Outdated
Comment thread .github/workflows/build-helm-release.yaml
spencercjh and others added 6 commits August 4, 2026 04:52
Signed-off-by: Spencer Cai <jiahao.cai@dynamia.ai>
Signed-off-by: Spencer Cai <jiahao.cai@dynamia.ai>
Signed-off-by: Spencer Cai <jiahao.cai@dynamia.ai>
Signed-off-by: Spencer Cai <jiahao.cai@dynamia.ai>
Signed-off-by: spencercjh <spencercjh@gmail.com>
Signed-off-by: spencercjh <spencercjh@gmail.com>
Signed-off-by: spencercjh <spencercjh@gmail.com>
@coderabbitai coderabbitai Bot added enhancement New feature or request and removed approved labels Aug 4, 2026
Signed-off-by: spencercjh <spencercjh@gmail.com>
Signed-off-by: spencercjh <spencercjh@gmail.com>

@archlitchi archlitchi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@hami-robot hami-robot Bot added the lgtm label Aug 4, 2026
@hami-robot

hami-robot Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: archlitchi, spencercjh

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@hami-robot hami-robot Bot added the approved label Aug 4, 2026
@hami-robot
hami-robot Bot merged commit 771e19f into Project-HAMi:main Aug 4, 2026
14 checks passed
@spencercjh
spencercjh deleted the feat/release-chart branch August 4, 2026 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants