Skip to content

Commit d991f3a

Browse files
authored
docs(new-release): Update docs based on new Craft flow (#19731)
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)
1 parent 7bfe71c commit d991f3a

File tree

1 file changed

+15
-19
lines changed

1 file changed

+15
-19
lines changed

docs/new-sdk-release-checklist.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -73,34 +73,30 @@ order**. Note that you can prepare the PRs at any time but the **merging oder**
7373

7474
- [ ] 1. If not yet done, be sure to remove the `private: true` property from your SDK’s `package.json`. Additionally,
7575
ensure that `"publishConfig": {"access": "public"}` is set.
76-
- [ ] 2. Make sure that the new SDK is **not added**
77-
in`[craft.yml](https://github.com/getsentry/sentry-javascript/blob/develop/.craft.yml)` as a target for the
78-
**Sentry release registry**\
79-
_Once this is added, craft will try to publish an entry in the next release which does not work and caused failed release
80-
runs in the past_
81-
- [ ] 3. Add an `npm` target in `craft.yml` for the new package. Make sure to insert it in the right place, after all
76+
- [ ] 2. Add an `npm` target in `craft.yml` for the new package. Make sure to insert it in the right place, after all
8277
the Sentry dependencies of your package but before packages that depend on your new package (if applicable).
8378
```yml
8479
- name: npm
8580
id: '@sentry/[yourPackage]'
8681
includeNames: /^sentry-[yourPackage]-\d.*\.tgz$/
8782
```
88-
- [ ] 4. Cut a new release (as usual, see
89-
[Publishing Release](https://github.com/getsentry/sentry-javascript/blob/develop/docs/publishing-a-release.md))
83+
- [ ] 3. Add a `registry` target in `craft.yml` for the new package.
84+
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)).
85+
```yml
86+
name: 'Sentry [Package] SDK'
87+
packageUrl: 'https://www.npmjs.com/package/@sentry/[package]'
88+
mainDocsUrl: 'https://docs.sentry.io/platforms/javascript/guides/[package]/'
89+
onlyIfPresent: /^sentry-[package]-\d.*\.tgz$/
90+
```
91+
- [ ] 4. Cut a new release (as usual, see
92+
[Publishing Release](https://github.com/getsentry/sentry-javascript/blob/develop/docs/publishing-a-release.md))
9093

9194
### After the Release
9295

93-
- [ ] 4. Check that the package was in fact published to NPM
94-
- [ ] 5. Add the new SDK to the [Sentry Release Registry](https://github.com/getsentry/sentry-release-registry) \
95-
Instructions on how to do this can be found [here](https://github.com/getsentry/sentry-release-registry#adding-new-sdks)
96-
\
97-
You have to fork this repo and PR the files from your fork to the main repo \
98-
[Example PR](https://github.com/getsentry/sentry-release-registry/pull/80) from the Svelte SDK
99-
100-
- [ ] 2. Add an entry to [craft.yml](https://github.com/getsentry/sentry-javascript/blob/develop/.craft.yml) to add
101-
releases of your SDK to the Sentry release registry \
102-
[Example PR](https://github.com/getsentry/sentry-javascript/pull/5547) from the Svelte SDK \
103-
_Subsequent releases will now be added automatically to the registry_
96+
- [ ] 1. Check that the package was in fact published to NPM
97+
- [ ] 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)
98+
- [ ] 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)
99+
[Example PR](https://github.com/getsentry/sentry-release-registry/pull/80) from the Svelte SDK.
104100

105101
## Follow-up Tasks
106102

0 commit comments

Comments
 (0)