Skip to content

docs(new-release): Update docs based on new Craft flow #19731

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

Merged
s1gr1d merged 2 commits into from
Mar 10, 2026
Merged

docs(new-release): Update docs based on new Craft flow #19731

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59313c6
docs(new-release): Update docs based on new Craft flow
s1gr1d Mar 10, 2026
a393b63
format
s1gr1d Mar 10, 2026
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
34 changes: 15 additions & 19 deletions docs/new-sdk-release-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,34 +73,30 @@ order**. Note that you can prepare the PRs at any time but the **merging oder**

- [ ] 1. If not yet done, be sure to remove the `private: true` property from your SDK’s `package.json`. Additionally,
ensure that `"publishConfig": {"access": "public"}` is set.
- [ ] 2. Make sure that the new SDK is **not added**
in`[craft.yml](https://github.com/getsentry/sentry-javascript/blob/develop/.craft.yml)` as a target for the
**Sentry release registry**\
_Once this is added, craft will try to publish an entry in the next release which does not work and caused failed release
runs in the past_
- [ ] 3. Add an `npm` target in `craft.yml` for the new package. Make sure to insert it in the right place, after all
- [ ] 2. Add an `npm` target in `craft.yml` for the new package. Make sure to insert it in the right place, after all
the Sentry dependencies of your package but before packages that depend on your new package (if applicable).
```yml
- name: npm
id: '@sentry/[yourPackage]'
includeNames: /^sentry-[yourPackage]-\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))
- [ ] 3. Add a `registry` target in `craft.yml` for the new package.
For new packages, Craft will automatically create the required directory structure and initial manifest in the Sentry Release Registry ([Craft Docs](https://craft.sentry.dev/targets/registry/#creating-new-packages)).
```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))

Comment on lines +85 to 93
Copy link

@sentry sentry bot Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

### After the Release

- [ ] 4. Check that the package was in fact published to NPM
- [ ] 5. Add the new SDK to the [Sentry Release Registry](https://github.com/getsentry/sentry-release-registry) \
Instructions on how to do this can be found [here](https://github.com/getsentry/sentry-release-registry#adding-new-sdks)
\
You have to fork this repo and PR the files from your fork to the main repo \
[Example PR](https://github.com/getsentry/sentry-release-registry/pull/80) from the Svelte SDK

- [ ] 2. Add an entry to [craft.yml](https://github.com/getsentry/sentry-javascript/blob/develop/.craft.yml) to add
releases of your SDK to the Sentry release registry \
[Example PR](https://github.com/getsentry/sentry-javascript/pull/5547) from the Svelte SDK \
_Subsequent releases will now be added automatically to the registry_
- [ ] 1. Check that the package was in fact published to NPM
- [ ] 2. Check that the SDK is added to the Sentry Release Registry [npm packages](https://github.com/getsentry/sentry-release-registry/tree/master/packages/npm/%40sentry) and [SDK symlinks](https://github.com/getsentry/sentry-release-registry/tree/master/sdks)
- [ ] 3. In case the package is missing anywhere, add the missing content. Instructions on how to do this can be found [here](https://github.com/getsentry/sentry-release-registry#adding-new-sdks)
[Example PR](https://github.com/getsentry/sentry-release-registry/pull/80) from the Svelte SDK.

## Follow-up Tasks

Expand Down