Skip to content

Latest commit

 

History

History
25 lines (14 loc) · 2.61 KB

RELEASE-PROCESS.md

File metadata and controls

25 lines (14 loc) · 2.61 KB
Raw

Release Process

  1. Once a change has been pushed to main, the publish GitHub action automatically publishes a new Docker image. See an example here.
  2. Validate the changes by testing the new image.
  3. Update VERSION and CHANGELOG.md to the updated version.
  4. Create a pull request for the update to the new version
  5. When the pull request is merged, create a tag for the new release. This will trigger the release GitHub action which tags the build with the correct version number. git tag v0.1.2 && git push --tag
  6. Copy and paste the CHANGELOG section for the new version into the release.

Automated deplpoyment to Lightstep staging and public enviroments

Both the publish Github Action and the Release Github Action initiate the staging-approval-public Github Action. If the initiation is from the publish Github Action the OTEL sidecar image tag will be set to the commit sha, if the initiation is from the release Github Action the OTEL sidecar image tag will be set to the tag.

The staging-approval-public Github Action initiates deployment to staging (passing in the relevant otel-sidecar image tag) and then waits for approval before deploying to public (see Approval for deployment to public below). The deployments themselves are carried out by the Codefresh listed pipelines deploy-prometheus-to-stg and deploy-prometheus-to-pub under this Codefresh Project

  • A Video walkthrough can be found here

Approval for deployment to public

The approval is implemented using a Github Environment protection rule here. Owners of this repo can modify the approvers list by navigating to Settings > Enviroments > public