Hacktoberfest 2026：維護者為十月標記出來的 issue，仍然開放、適合新手。 瀏覽 Hacktoberfest issue

Sentry Integration: Track staging commits

未關閉
  • 哪裡不對？
#1,241 0 則留言 0 個 reaction 已指派 1 人 在 GitHub 檢視

維護者通常 1 天內回覆

@vprashrex 已經在處理了。

開始於 2026年10月10日。

評估

這個 Issue 還沒有評估資料。

描述

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.
主要語言
Python
星號
18
分支
11
平均合併
3 天 11 小時
30 天內合併 PR
8

環境準備

從這裡開始

  1. 先讀完整個 Issue，再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫，在一個分支上完成修改。
  4. 送出 Pull Request，並在描述裡引用這個 Issue 編號。

ProjectTech4DevAI/kaapi-backend 的其他 Issue

查看 ProjectTech4DevAI/kaapi-backend 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。