-
-
Notifications
You must be signed in to change notification settings - Fork 9.7k
Release: Adds Sentry release creation after publishing to npm #32356
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds automated Sentry release creation after NPM publishing to help track releases and errors across different environments. The integration follows Sentry's recommended GitHub Actions workflow.
- Adds Sentry release action using
sentry/action-release@v2
- Automatically determines environment based on version suffixes (alpha, beta, rc, or latest)
- Configures authentication and project settings via GitHub secrets
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
.github/workflows/publish.yml
Outdated
SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }} | ||
with: | ||
release: ${{ steps.version.outputs.current-version }} | ||
environment: ${{ contains(steps.version.outputs.current-version, '-alpha') && 'alpha' || contains(steps.version.outputs.current-version, '-beta') && 'beta' || contains(steps.version.outputs.current-version, '-rc') && 'rc' || 'latest' }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The environment detection logic is complex and hard to read. Consider using a separate step to set the environment variable or breaking this into multiple conditional steps for better maintainability.
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i agree with this but it's also not logic we're reusing anywhere else.
@ndelangen think it makes sense to split out alpha
beta
and rc
like that? or should we stick with the release tags: just prerelease
and latest
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could group all prereleases under a single "prerelease" if you prefer.
It will just take a little change in the server-function reporting to Sentry.
Shall I make that change?, mind you that will not change any events currently already in Sentry.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes let's do that. i will update this PR to only have prereleas
and latest
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The change to the event-log function is made.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 file reviewed, 1 comment
View your CI Pipeline Execution ↗ for commit f7b9fea
☁️ Nx Cloud last updated this comment at |
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
What I did
Add Sentry release creation after publishing to npm. This helps track releases and errors across different release channels. Ref: Sentry docs
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
bug
: Internal changes that fixes incorrect behavior.maintenance
: User-facing maintenance tasks.dependencies
: Upgrading (sometimes downgrading) dependencies.build
: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup
: Minor cleanup style change. Will not show up in release changelog.documentation
: Documentation only changes. Will not show up in release changelog.feature request
: Introducing a new feature.BREAKING CHANGE
: Changes that break compatibility in some way with current major version.other
: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/core
team here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>