docs(new-release): Update docs based on new Craft flow#19731
Merged
Conversation
andreiborza
approved these changes
Mar 10, 2026
Member
andreiborza
left a comment
andreiborza
left a comment
There was a problem hiding this comment.
Nice, thanks for updating this!
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
+85
to
93
| ```yml | ||
| name: 'Sentry [Package] SDK' | ||
| packageUrl: 'https://www.npmjs.com/package/@sentry/[package]' | ||
| mainDocsUrl: 'https://docs.sentry.io/platforms/javascript/guides/[package]/' | ||
| onlyIfPresent: /^sentry-[package]-\d.*\.tgz$/ | ||
| ``` | ||
| - [ ] 4. Cut a new release (as usual, see | ||
| [Publishing Release](https://github.com/getsentry/sentry-javascript/blob/develop/docs/publishing-a-release.md)) | ||
|
|
There was a problem hiding this comment.
Bug: The YAML snippet in the new SDK release checklist is structurally incorrect and inconsistent with the actual .craft.yml configuration, which will cause release automation to fail.
Severity: HIGH
Suggested Fix
Update the YAML code block in docs/new-sdk-release-checklist.md to reflect the correct nested structure. The properties should be shown under an sdks key and a specific package identifier, for example: sdks: 'npm:@sentry/[yourPackage]': ....
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: docs/new-sdk-release-checklist.md#L85-L93
Potential issue: The YAML snippet in the new SDK release checklist for configuring the
`registry` target in `.craft.yml` is incorrect. The documentation shows a flat structure
for properties like `name` and `packageUrl`. However, the actual configuration requires
these properties to be nested under an `sdks` dictionary with a specific SDK key, such
as `'npm:@sentry/[yourPackage]'`. Following the current documentation will result in an
invalid YAML structure, causing the Craft release automation to either fail parsing the
file or ignore the new SDK entry entirely, preventing its automatic registration.
Did we get this right? 👍 / 👎 to inform future reviews.
This was referenced Mar 10, 2026
s1gr1d
added a commit
that referenced
this pull request
Mar 10, 2026
Small addition to this PR: #19731 Reference (adds `sdkName`): getsentry/craft#769 Closes #19737 (added automatically)
andreiborza
pushed a commit
that referenced
this pull request
Mar 11, 2026
We don't need to create PRs to add new packages to the registry. Craft can now do this automatically. Documented here: https://craft.sentry.dev/targets/registry/#creating-new-packages Closes #19732 (added automatically)
andreiborza
pushed a commit
that referenced
this pull request
Mar 11, 2026
Small addition to this PR: #19731 Reference (adds `sdkName`): getsentry/craft#769 Closes #19737 (added automatically)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We don't need to create PRs to add new packages to the registry. Craft can now do this automatically.
Documented here: https://craft.sentry.dev/targets/registry/#creating-new-packages
Closes #19732 (added automatically)