Skip to content

fix(ci): inject Sentry debug IDs at build time so uploaded source maps match the deployed bundles #1213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ThibaudDauce wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix(ci): inject Sentry debug IDs at build time so uploaded source maps match the deployed bundles #1213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,13 @@ jobs:
- name: Build application
run: NUXT_APP_COMMIT_ID=$(git rev-parse --short HEAD) pnpm run build

# Injection rewrites the bundles and shifts their source maps by the same amount, so it
# has to happen on the artifact everyone downloads. Done in the `sentry` job instead, it
# would only ever touch a copy that is never deployed, and the maps would be uploaded
# two lines off. No credentials needed: the command only writes ids into the files.
- name: Inject Sentry debug IDs
run: pnpm dlx @sentry/cli sourcemaps inject .output/public/_nuxt

- name: Upload build artifacts
uses: actions/upload-artifact@v7
with:
Expand Down Expand Up @@ -421,6 +428,10 @@ jobs:
SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
SENTRY_URL: ${{ secrets.SENTRY_URL }}
with:
# Injection happens during the build, on the artifact this job downloads. Letting
# the action do it here would rewrite its own copy and upload maps two lines off
# from the deployed bundles.
inject: false
sourcemaps: ".output/public/_nuxt"
url_prefix: "~/_nuxt"
environment: ${{ github.ref_name }}
Expand Down
7 changes: 4 additions & 3 deletions nuxt.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,10 @@ export default defineNuxtConfig({
},
sentry: {
sourceMapsUploadOptions: {
// disable sourcemaps upload from build, it's done later during the release with sentry-cli
// Keeping the bundler plugin out also keeps it from stamping its own debug id: it only
// writes one as a runtime snippet, never the `//# debugId=` comment and the matching
// key in the map that an upload pairs on, so it would compete with the id the CI build
// injects rather than replace it. Upload is done during the release with sentry-cli.
enabled: false,
},
},
Expand All @@ -431,6 +434,4 @@ export default defineNuxtConfig({

// TODO: add /support pages
},
// TODO: add sentry config for stack traces based on source maps
// https://docs.sentry.io/platforms/javascript/guides/nuxt/#add-readable-stack-traces-to-errors
})
Loading