Repository navigation
Sentry Integration: Track staging commits #1241
Description
Is your feature request related to a problem?
Staging deploys for every green main CI run do not correctly capture commit shas in Sentry releases. With multiple changes landing on staging, it is difficult to identify which merge introduced a staging issue.
Describe the solution you'd like
Implement the shared release-id code from the production issue:
- Update
docker-compose.staging.ymlto passRELEASE_TAGalongsideGIT_SHAfor backend services. - In
deploy-staging.yml, setRELEASE_TAG=mainandGIT_SHA=$DEPLOY_SHAin thedocker compose buildcommand. - Checkout the repo with
fetch-depth: 0after the SSM command succeeds. - Register the release and deploy using
getsentry/action-releaseonly if the SSM deploy is successful. - Reuse the
SENTRY_AUTH_TOKENsecret andSENTRY_ORGvariable; addSENTRY_STAGING_PROJECTaskaapi-staging.
Why is this enhancement needed?
This enhancement will ensure each staging deploy is associated with its specific commits, allowing quick identification of the source of staging issues before changes reach production.
Original issue
Describe the current behavior
Staging deploys on every green main CI run through .github/workflows/deploy-staging.yml (SSM → EC2 → docker compose -f docker-compose.staging.yml). The commit sha is already passed as the GIT_SHA build arg, but the Sentry release id ignores it, so every staging event in the kaapi-staging project reports the same release. Many changes land on staging between production releases, and there is no way to tell which merge introduced a staging issue.
Describe the enhancement you'd like
Depends on the shared release-id code from the production issue (kaapi-backend@<RELEASE_TAG or API_VERSION>+<git sha 12>).
docker-compose.staging.yml: passRELEASE_TAGas a build arg next toGIT_SHAfor every service that builds the backend image.deploy-staging.yml:- set
RELEASE_TAG=mainalongsideGIT_SHA=$DEPLOY_SHAin thedocker compose buildcommand - checkout the repo with
fetch-depth: 0in a step after the SSM command succeeds - register the release and deploy with
getsentry/action-release(release: kaapi-backend@main+<DEPLOY_SHA 12>,environment: staging,set_commits: auto) only when the SSM deploy succeeded
- set
- GitHub setup: reuse the
SENTRY_AUTH_TOKENsecret andSENTRY_ORGvariable; addSENTRY_STAGING_PROJECT=kaapi-staging.
Why is this enhancement needed?
Each staging deploy becomes a Sentry release with its commits, so a new staging issue points at the merge that caused it before the change reaches production.
Additional context
- Use
DEPLOY_SHA(workflow_run.head_sha), notgithub.sha: this workflow is triggered byworkflow_run, wheregithub.shais the default-branch head, not necessarily the deployed commit. deploy-staging-ecs.yml(manualworkflow_dispatch) is a second staging path; decide whether it stays and, if so, apply the same steps there.- Verify after the next
mainmerge: Sentry → Releases inkaapi-stagingshowskaapi-backend@main+<sha>understagingwith commits attached.
Metadata
Metadata
Assignees
Labels
Type
Projects
- StatusShow more project fieldsTo Do
Activity
[-]Sentry release tracking for staging EC2 deploys (git sha per main merge)[/-][+]Sentry Integration: Track staging commits[/+]