OCI Registry Helm Distribution and Security Enhancements #52
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix YAML syntax error on line 102 caused by multi-line string with
embedded GitHub Actions expressions.
Changed from inline string variable to heredoc file approach:
- Extract all GitHub expressions to shell variables first
- Use heredoc to write tag message to temp file
- Pass file to git tag with -F flag
This avoids YAML parsing issues with special characters and
multi-line strings containing ${{ }} expressions.
Fixes: Invalid workflow file syntax error
🤖 Generated with Claude Code
Co-Authored-By: Claude <noreply@anthropic.com>
Copilot finished reviewing on behalf of
vivekr-splunk
November 18, 2025 17:23
vivekr-splunk
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a YAML syntax error in the create-release-tag workflow caused by multi-line strings containing GitHub Actions expressions. The fix refactors the tag message creation to use a heredoc approach with a temporary file.
Key Changes:
- Extract GitHub Actions expressions (
steps.commit.outputs.*,github.actor) to shell variables before building the tag message - Replace inline multi-line string with heredoc writing to
/tmp/tag_message.txt - Update
git tagcommand to read message from file using-Fflag instead of inline-mflag
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| # Create annotated tag | ||
| git tag -a "$TAG" -m "$TAG_MESSAGE" | ||
| git tag -a "$TAG" -F /tmp/tag_message.txt |
There was a problem hiding this comment.
[nitpick] Consider adding cleanup for the temporary file after the tag is created. While GitHub Actions runners are ephemeral and this won't cause issues in practice, it's a good practice to clean up temporary resources:
# Create annotated tag
git tag -a "$TAG" -F /tmp/tag_message.txt
# Clean up temporary file
rm -f /tmp/tag_message.txt
Suggested change
| git tag -a "$TAG" -F /tmp/tag_message.txt | |
| git tag -a "$TAG" -F /tmp/tag_message.txt | |
| # Clean up temporary file | |
| rm -f /tmp/tag_message.txt |
Pull Request Test Coverage Report for Build 19475368201Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
Add cleanup step to remove temporary file after tag creation. While GitHub Actions runners are ephemeral, this follows best practices for resource cleanup. Addresses: Copilot review suggestion
rlieberman-splunk
approved these changes
Nov 18, 2025
Use quoted heredoc ('EOF' instead of EOF) to prevent variable
expansion issues in YAML/bash. Replace variables after heredoc
using sed to avoid special character and newline problems.
Changes:
- Use <<'EOF' to prevent immediate variable expansion
- Remove emoji that might cause encoding issues
- Use sed to replace variables in the temp file
- Simplifies YAML parsing and prevents syntax errors
Fixes: YAML syntax error on line 104
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR modernizes the Helm chart distribution strategy and significantly enhances supply chain security by implementing OCI registry-based distribution and pinning all GitHub Actions to commit hashes.
Key Changes
1. 🎯 OCI Registry for Helm Charts (Primary Distribution)
oci://ghcr.io/splunk/charts/splunk-ai-operator.tgzfiles committed to git repository.tgzfiles maintained for backward compatibility (Helm < 3.8)Benefits:
2. 🐳 Docker Image Build in Release Workflow
release-package-helm.ymlv0.1.0,0.1.0,0.1,latestBefore: Release workflow only packaged Helm charts (images missing!)
After: Complete release automation (Docker + Helm + Manifests)
3. 🔒 Supply Chain Security - Pinned GitHub Actions
All GitHub Actions pinned to commit hashes to prevent supply chain attacks:
Workflows Updated:
main-unit-tests.yml- All actions pinnedmain-build-image.yml- All Docker actions pinnedprerelease-update-versions.yml- Third-party actions pinnedhelm-lint-test.yml- All actions pinnedrelease-package-helm.yml- All actions pinnedcodeql-analysis.yml- CodeQL actions pinnedThird-party actions secured (highest priority):
coverallsapp/github-action@v2→5cbfd81b...jacobtomlinson/gha-find-replace@v3→2ff30f64...peter-evans/create-pull-request@v3.10.1→7380612b...azure/setup-helm@v4→bf6a7d30...helm/chart-testing-action@v2.6.1→e6669bcd...helm/kind-action@v1.10.0→0025e74a...softprops/action-gh-release@v1→26994186...Security benefits:
4. 📚 Documentation Updates
All documentation updated to reflect OCI registry and version 0.1.0:
Files Updated:
README.md- OCI registry as primary methoddocs/installation.md- Complete rewrite with OCI as Method 1docs/deployment/helm-deployment.md- OCI registry examplesdocs/releases.md- Release process with version 0.1.0Version Correction: Changed all examples from
1.0.0to0.1.0(pre-GA release)5. 🔧 Workflow Fixes
developbranch triggerscreate-release-tag.ymlInstallation Examples
OCI Registry (Recommended - Helm 3.8+)
Release Artifacts
When v0.1.0 is released, the following will be published:
OCI Registry (GHCR):
Docker Images:
GitHub Release:
Testing
Breaking Changes
None - backward compatible. GitHub Release .tgz files still available for Helm < 3.8.
Migration Path
For users on Helm 3.8+: Migrate to OCI registry (recommended)
For users on Helm < 3.8: Continue using GitHub Release URLs
Checklist
Post-Merge Actions
After this PR is merged:
Related Issues
Fixes: CodeQL warning "Unpinned tag for a non-immutable Action"Fixes: PR merge blocked by "Code scanning is waiting for results"Fixes: Docker images not built during releases