docs: add RELEASING.md#113
Open
monrax wants to merge 1 commit into
Open
Conversation
Document the version-driven release process for the chart (pre-release testing, values drift check, optional trivy scan, Chart.yaml update, cutting the release via chart-releaser, and verifying publication on Artifact Hub). Closes #27. Co-Authored-By: Claude Opus 4.8 (1M context) <[EMAIL_ADDRESS_REDACTED]>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Documents the release process for the chart in a new
docs/RELEASING.md, and links to it fromCONTRIBUTING.md.Details
docs/RELEASING.md: version-driven release model (chart-releaser triggered by aversionbump inChart.yaml), who can release, versioning (chartversionvsappVersion), and step-by-step release procedure — E2E testing on MicroK8s + EKS, values drift check (values.yaml/values.schema.json/ README values reference), optionaltrivyscan,Chart.yamlupdate (version +artifacthub.io/changeschangelog), cutting the release, and verifying publication on Artifact Hub. Includes a copy-paste release checklist and a troubleshooting section (covers the422 tag_name already_existscase).CONTRIBUTING.mdsummarizing the flow and linking todocs/RELEASING.md.Linked issues
This fixes #27
PR Checklist
Please check the items that apply to your change.
Testing Checklist
Documentation-only change — no chart templates, values, or workflows modified; install/functional/upgrade tests are not applicable.
Static Validation
helm lint ./charts/grayloghelm template graylog ./charts/graylog --validateInstallation
helm install graylog ./charts/graylogkubectl rollout status statefulset/grayloghelm test graylogFunctional (if applicable)
Upgrade (if applicable)
Specific to this PR
Notes for reviewers
🤖 Generated with Claude Code