Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Sentry Integration: Track staging commits

Aberta
  • Algo errado?
#1,241 0 comentários 0 reações 1 responsável Ver no GitHub

Mantenedores costumam responder em até 1 dia

@vprashrex já está trabalhando nisso.

Desde 10/10/2026.

Avaliação

Esta issue ainda não foi avaliada.

Descrição

enhancement

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.yml to pass RELEASE_TAG alongside GIT_SHA for backend services.
  • In deploy-staging.yml, set RELEASE_TAG=main and GIT_SHA=$DEPLOY_SHA in the docker compose build command.
  • Checkout the repo with fetch-depth: 0 after the SSM command succeeds.
  • Register the release and deploy using getsentry/action-release only if the SSM deploy is successful.
  • Reuse the SENTRY_AUTH_TOKEN secret and SENTRY_ORG variable; add SENTRY_STAGING_PROJECT as kaapi-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: pass RELEASE_TAG as a build arg next to GIT_SHA for every service that builds the backend image.
  • deploy-staging.yml:
    • set RELEASE_TAG=main alongside GIT_SHA=$DEPLOY_SHA in the docker compose build command
    • checkout the repo with fetch-depth: 0 in 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
  • GitHub setup: reuse the SENTRY_AUTH_TOKEN secret and SENTRY_ORG variable; add SENTRY_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), not github.sha: this workflow is triggered by workflow_run, where github.sha is the default-branch head, not necessarily the deployed commit.
  • deploy-staging-ecs.yml (manual workflow_dispatch) is a second staging path; decide whether it stays and, if so, apply the same steps there.
  • Verify after the next main merge: Sentry → Releases in kaapi-staging shows kaapi-backend@main+<sha> under staging with commits attached.
Linguagem predominante
Python
Estrelas
18
Forks
11
Merge médio
3d 11h
PRs com merge (30d)
8

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de ProjectTech4DevAI/kaapi-backend

Todas as issues de ProjectTech4DevAI/kaapi-backend

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.