fix(craft): Add missing mainDocsUrl for @sentry/effect SDK#19860
fix(craft): Add missing mainDocsUrl for @sentry/effect SDK#19860
Conversation
The Effect SDK was missing the mainDocsUrl field in the craft configuration, causing KeyError: 'main_docs_url' in Sentry backend (SENTRY-5M6R). This adds the documentation URL following the same pattern as other JavaScript SDKs in the registry. Fixes SENTRY-5M6R
Lms24
left a comment
Lms24
left a comment
There was a problem hiding this comment.
Thanks for opening this PR Since when is this required? None of the other packages define this property.
|
We might need to fix this in the release registry directly since we already made the first release. |
I was thinking we would do a re-release, but maybe that's not the right thing to do because this release is broken. Do you know how to fix it directlyi? |
size-limit report 📦
|
Claude says: The problem is that @sentry/effect explicitly defined custom fields (name, sdkName, packageUrl) but didn't include mainDocsUrl. This likely prevented Craft from using its default URL generation logic. When an SDK entry has custom fields, it seems Craft expects you to provide ALL the necessary fields, including So mainDocsUrl is required when:
|
|
Would a new release of Also I feel like craft should have caught this before, I think this needs to be improved - I could follow up on this |
|
let's not merge this please |
Yes, it would be good for it to verify the required properties. cc'ing Mr. Craft @BYK |
|
I'll close this in favor of getsentry/sentry-release-registry#229 |
|
After thinking over it. Reopening since we still have to have it actually |
|
Yeah let's wait with closing this until we properly investigate things tomorrow. If the outcome is that this needs to be set by SDKs now, it would be a fairly drastic change. So I'd prefer it if we can somehow infer this in craft. |
|
Read the docs please: https://craft.sentry.dev/targets/registry/#creating-new-packages :) |
There was a problem hiding this comment.
I think it makes sense for us to still set this, be it primarily just for documentation purposes in this case, since the field was added manually to the registry. cc @JPeer264 gonna leave this up to you to merge (now or once the docs land)
|
Let's do it |
## Problem The @sentry/effect SDK was added to the release registry without the required `mainDocsUrl` field in the craft configuration. This causes a KeyError in the Sentry backend when trying to access SDK documentation URLs. **Sentry Issue**: [SENTRY-5M6R](https://sentry.sentry.io/issues/7341944871/) - **Error**: `KeyError: 'main_docs_url'` - **Impact**: 238,811 occurrences affecting 3,994 users - **First seen**: March 17, 2026 at 16:50 UTC (shortly after Effect SDK was released at 16:44 UTC) ## Solution This PR adds the missing `mainDocsUrl` field to the Effect SDK configuration in `.craft.yml`, following the same pattern as other JavaScript SDKs. ## Changes - Added `mainDocsUrl: 'https://docs.sentry.io/platforms/javascript/guides/effect/'` to the Effect SDK registry configuration ## Testing - [ ] Verified the URL format matches other JavaScript SDK documentation URLs - [ ] Confirmed the field name matches the registry specification ## Impact - Future releases of @sentry/effect will include the proper documentation URL in the release registry - This prevents the KeyError from occurring in the Sentry backend Fixes SENTRY-5M6R
5 participants
Problem
The @sentry/effect SDK was added to the release registry without the required
mainDocsUrlfield in the craft configuration. This causes a KeyError in the Sentry backend when trying to access SDK documentation URLs.Sentry Issue: SENTRY-5M6R
KeyError: 'main_docs_url'Solution
This PR adds the missing
mainDocsUrlfield to the Effect SDK configuration in.craft.yml, following the same pattern as other JavaScript SDKs.Changes
mainDocsUrl: 'https://docs.sentry.io/platforms/javascript/guides/effect/'to the Effect SDK registry configurationTesting
Impact
Fixes SENTRY-5M6R