Project: Sentry in CI/CD

[smeubank]

Project Board

See our project board to track this initiative across all SDKs

Description

Ideally we attempt to automate, modify, and at least provide simple methods for users to inject sentry into their CI/CD pipelines. This include providing detection, automated integration, & pragmatic documentation on why it's beneficial. The why in a nutshell is that to be able to get full advantage of Sentry, you must have Sentry as part of the full dev and software delivery life cycle. Meaning new code, new versions of app, new releases, Sentry should have all that context. So you can fix problems faster when Sentry summarizes all relevant info in front of you.

Concrete Tasks

Beta Give feedback

1. Remix flow in source maps
2. Automatically insert plugin into Webpack config sentry-wizard#418
   Platform: Sourcemaps +1
   
3. Automatically adjust tsconfig.json to emit source maps sentry-wizard#403
   Platform: Sourcemaps +1
   
4. Webpack, Vite, TSC fallback config file create if not found
5. Review Docs after customer calls; Find reasons why people end up in "wrong" docs

Things we discussed but decided to hold off for now:

• Direct using API integrations on Vercel, Netlfy, CloudFlare etc
• Automate setting up the Sentry Vercel/netflify integration
  • env variables are set
  • build command is adjusted (if necssary)

// via Sentry client infra tooling (wizards, plugins, cli, GHAs)

• detect deployment platforms
  • netlify.toml

Features dependent upon:

• ~ Releases
• Upload source maps/context
• git history and suspect commits

Hosting Provider:

• AWS
• GCP
• Azure (azure-pipelines.yml)
• Netlify (netlify.toml)
• Vercel (???) requires special formatted env variables PUBLIC_%
• Cloudflare (wrangler.toml)

CI/CD Tools:

• GHA
• Jenkins
• Cloud Provider Pipelines

Platform specific:

• package.json scripts
• webpack, vite, rollup, esbuild etc
• Nx
• Fastlane (iOS)

[AbhiPrasad]

Related: getsentry/develop#755

[tonyo]

Most of the established CI/CD tools have some sort of hooks/handlers triggered on workflow events (build started, succeeded, failed), so that could be a good integration point to inject Sentry-related steps.

Examples:

• Exit handlers in Argo Workflows
• Resource hooks in ArgoCD
• Conditional steps in GitHub Actions
• Post-build tasks in Jenkins

Questions I have at this point: what exact data would be most useful for users to have inside Sentry? How would we make it helpful/actionable in the bigger context (linking to releases, codecov data) and not just "yet another thing that Sentry can monitor"?

A related hackweek project: https://hackweek.getsentry.net/years/2021/projects/-MfntUplvj4OU6C3lOd1/add-instrumentation-to-githubs-ci
Also an honorable mention of https://github.com/getsentry/zeus/

[Lms24]

Regarding the last task, I did some digging, reading logs from customer calls RE source maps docs and two things came up:

• Confusion around releases and our new artifact bundles when using Sentry CLI
  • Tried to clarify this in ref(js): Clarify release creation in Sentry CLI source maps upload guide sentry-docs#7875
• Question around which tool to use for Vue and how docs were confusing
  • Added missing wizard snippet in ref(js): Add Source Maps wizard snippet to Vue Source Maps page sentry-docs#7874

I couldn't find other actionable feedback so once these PRs are merged, I'm gonna close this issue as completed. Happy to revisit docs If other things come up in the future.

[Lms24]

Closing as all concrete tasks are completed.