Skip to content

docs(agents): enhance release process to include Helm chart updates #60

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.

Sign up for GitHub

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

Open
cjeanner wants to merge 1 commit into
base: main
Choose a base branch
from
+37 −0
Open

docs(agents): enhance release process to include Helm chart updates #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/agents/releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,48 @@ In particular, verify and update any `?ref=` or similar version selectors in:
- `/charts` (chart values, templates, or helper files that reference this repo)
- Any `README.md` or other documentation files in this repo

**Helm chart version management:**

When bumping to a new release tag, also update the Helm chart metadata and values:

1. **Chart version** in `/charts/rhoso-apps/Chart.yaml`:
- Update the `version` field to match the new tag (e.g., `vX.Y.Z` → `version: X.Y.Z` without the `v` prefix)

2. **Application targetRevisions** in `/charts/rhoso-apps/values.yaml`:
- Update all `targetRevision` fields under `applications.*` to the new tag (e.g., `targetRevision: vX.Y.Z`)
- These are NOT `?ref=` patterns but still need updating to match the release

3. **Test expectations** in `/charts/rhoso-apps/tests/application_test.yaml`:
- Update any assertions that check `spec.source.targetRevision` values
- Search for the old version string and replace with the new one to prevent test failures

Rules for agents:

- Do not leave `?ref=` values pointing to older tags or branches once a new release tag is intended to be the default example.
- Prefer pinned, explicit tags over branch names like `main`, `master`, or feature branches in all references to this repository.
- When introducing new examples or references that point to this repository, always use the **current** released tag, not a branch name.
- When checking `?ref=`, treat URLs that contain `openstack-k8s-operators/gitops` as references to this repository.
- **For Helm chart releases**: Update Chart.yaml version, all values.yaml targetRevision fields, AND test assertions in the same commit batch.
- **Validation**: After bumping versions, verify that tests still pass by checking what CI runs (see [ci-and-validation.md](ci-and-validation.md)).

If the repository maintainers follow a specific naming scheme for tags (for example, `vMAJOR.MINOR.PATCH`), preserve that scheme and do not invent new formats.

**Complete checklist for version bumps:**

1. Search and replace `?ref=vOLD` → `?ref=vNEW` in:
- `applications/*.yaml` (component references)
- `example/*/kustomization.yaml` (component references)
- `example/*/README.md` (documentation examples)
- `components/*/README.md` (usage examples)
- `charts/*/README.md` (documentation examples)

2. Update Helm chart files:
- `charts/rhoso-apps/Chart.yaml`: `version` field
- `charts/rhoso-apps/values.yaml`: all `targetRevision` fields
- `charts/rhoso-apps/tests/application_test.yaml`: assertion values

3. Verify no references were missed:
```bash
# Should return no results if all same-repo refs are updated
grep -r "ref=vOLD" --include="*.yaml" --include="*.yml" --include="*.md" . | grep "openstack-k8s-operators/gitops"
```