Skip to content

RELEASE.md

Latest commit

 

History

History
44 lines (36 loc) · 2.97 KB

RELEASE.md

File metadata and controls

44 lines (36 loc) · 2.97 KB
Raw

Release

Versioning

Currently the helm chart version is mirroring major and minor version of the Splunk OpenTelemetry Collector image, e.g. if the chart uses 0.40.0 version of Splunk OTel Collector image as default, the chart version should have 0.40.x version where x is a patch number. This may be changed once Splunk OpenTelemetry Collector reaches GA.

Version of Splunk OTel Collector image is set as value of appVersion field in Chart.yaml, version of the helm chart release is set as value of version field.

Release Procedure

Using GitHub Workflows

  1. When a new upstream collector release is available, the Release Drafter workflow automatically creates a release PR every 12 hours at 00:55 UTC and 12:55 UTC.
    • This schedule corresponds to:
      • 5:55 AM / 5:55 PM during Daylight Saving Time (PDT / UTC−7)
      • 4:55 AM / 4:55 PM during Standard Time (PST / UTC−8)
    • To trigger the workflow outside the scheduled times, use the "Run workflow" button with default input parameters.
  2. After the release PR is created:
    • Review the code changes
    • Ensure all checks have passed to validate chart functionality
      • Note: Due to a GitHub limitation, PRs created by workflows may not trigger downstream checks automatically. A repository approver may need to close and reopen the PR to kick off the required checks. This is a known issue we’re working to improve.
    • Approve and merge the PR
  3. The Release Charts workflow will publish the release shortly after.
    • That’s it — you’re done!
    • Automation prevents duplicate or invalid releases. If a release isn’t created, you can check for failed workflow run info here.

Manually Making a Release

  1. Version Update: Manually edit Chart.yaml to update the version field.
  2. Dependencies & Rendering: Execute make render to update Helm dependencies and apply changes.
  3. CHANGELOG Update: Run make chlog-update to incorporate changes into the CHANGELOG.
  4. Stage & Commit Changes:
    1. Stage all changes: git add .
    2. Commit with a message: git commit -m "Prepare release {version}"
  5. Create a pull request:
    1. Push your commits to the signalfx owned remote repository.
    2. Create a PR for your changes against the main branch.
  6. Review code changes, validate chart functionality, approve the PR, and merge the PR.