Skip to content

Update claude.md for helm charts #2038

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.

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

Merged
merged 1 commit into from
Jul 23, 2025
Merged

Update claude.md for helm charts #2038

merged 1 commit into from
Jul 23, 2025

Conversation

ZIJ
Copy link
Contributor

@ZIJ ZIJ commented Jul 23, 2025

No description provided.

@ZIJ ZIJ merged commit 8b1235f into develop Jul 23, 2025
12 checks passed
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Summary

This PR updates the CLAUDE.md documentation file in the helm-charts directory to provide more accurate and comprehensive guidance for Claude Code when working with Digger's Helm charts. The changes address several key areas:

Monorepo Structure Clarification: The documentation now explicitly states that the Helm charts are part of the main digger monorepo but are published to an OCI registry for distribution, helping to clarify the development vs. distribution model.

CI/CD Workflow Updates: The documentation has been updated to reflect the actual GitHub Actions workflows currently in use, including the correct workflow file names (.github/workflows/helm-test.yml for PR testing and .github/workflows/helm-release.yml for releases) and the publishing process to GitHub Container Registry at oci://ghcr.io/diggerhq/helm-charts/digger-backend.

Configuration Examples Corrections: The examples have been corrected to use proper field names and structure, specifically changing incorrect references like 'secrets' to 'secret' and 'githubAppId' to 'githubAppID', which prevents common configuration errors.

New Monorepo Integration Section: A comprehensive new section has been added that covers critical aspects of working with the monorepo structure, including directory organization, publishing strategy, version management practices, and common configuration pitfalls that developers might encounter.

This documentation update serves as a reference guide for Claude Code to better understand and work with Digger's Helm chart infrastructure, ensuring more accurate assistance when dealing with configuration and deployment issues. The changes reflect the current state of the system and address gaps that were likely causing confusion or errors in previous interactions.

Confidence score: 5/5

• This PR is extremely safe to merge as it only contains documentation improvements with no code changes.
• The score is 5/5 because this is purely documentation that improves accuracy and completeness without any risk to production systems.
• No files need additional attention as this is a straightforward documentation update.

1 file reviewed, no comments

Edit Code Review Bot Settings | Greptile

Copy link
Contributor

bismuthdev bot commented Jul 23, 2025

Summary of Bugs Found in Codebase

Total bugs found: 2

Bug Descriptions

  1. Inconsistent Base64 Encoding in Secret Template - In the Helm chart's digger-secret.yaml, there's an inconsistency in how the GitHub App private key is handled. The documentation states the key should be base64 encoded, but the template handles encoding inconsistently between different lines, potentially causing authentication issues.

  2. Incorrect OCI Registry Path in Documentation - The documentation in CLAUDE.md incorrectly states that the Helm chart is published to oci://ghcr.io/diggerhq/helm-charts/digger-backend, while the actual path used in the GitHub workflow is oci://ghcr.io/diggerhq/helm-charts without the /digger-backend suffix.

- **Pull Request Testing**: Automatically runs `helm unittest` on PR changes
- **Release Process**: On merge to main, runs linting, testing, and publishes to GitHub Pages
- **Pull Request Testing** (`.github/workflows/helm-test.yml`): Runs `helm unittest` and linting on PR changes to helm-charts/
- **Release Process** (`.github/workflows/helm-release.yml`): On merge to main, publishes to GitHub Container Registry at `oci://ghcr.io/diggerhq/helm-charts/digger-backend`
Copy link
Contributor

Choose a reason for hiding this comment

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

There's a documentation error in CLAUDE.md. The file states that the Helm chart is published to oci://ghcr.io/diggerhq/helm-charts/digger-backend, but the actual GitHub workflow in .github/workflows/helm-release.yml (line 31) shows that the chart is pushed to oci://ghcr.io/diggerhq/helm-charts without the /digger-backend suffix.

The Helm OCI registry path doesn't include the chart name as part of the registry URL. Instead, when using helm push, the chart name is included in the package that's being pushed, not in the registry path itself. The documentation should be updated to reflect the correct OCI registry path.

Suggested change
- **Release Process** (`.github/workflows/helm-release.yml`): On merge to main, publishes to GitHub Container Registry at `oci://ghcr.io/diggerhq/helm-charts/digger-backend`
- **Release Process** (`.github/workflows/helm-release.yml`): On merge to main, publishes to GitHub Container Registry at `oci://ghcr.io/diggerhq/helm-charts`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant