Skip to content

docs: Add docs on building the SDK#10368

Merged
AbhiPrasad merged 1 commit intodevelopfrom
fn/docs-build
Jan 26, 2024
Merged

docs: Add docs on building the SDK#10368
AbhiPrasad merged 1 commit intodevelopfrom
fn/docs-build

Conversation

@mydea
Copy link
Copy Markdown
Member

@mydea mydea commented Jan 26, 2024

As this comes up every now and then (e.g. #5108), I gather it makes sense to document how to build the SDK youself. I added a note to explicitly state that there are no guarantees there.

@mydea mydea requested review from AbhiPrasad and Lms24 January 26, 2024 14:28
@mydea mydea self-assigned this Jan 26, 2024
@AbhiPrasad AbhiPrasad merged commit 1f3a796 into develop Jan 26, 2024
@AbhiPrasad AbhiPrasad deleted the fn/docs-build branch January 26, 2024 20:33
@AbhiPrasad AbhiPrasad mentioned this pull request Feb 2, 2024
Closed
3 tasks
@anthonyryan1
Copy link
Copy Markdown

anthonyryan1 commented Feb 3, 2024 •
edited
Loading

I appreciate the effort, but this still doesn't address #5108

Here's an example trying to follow your instructions:

npm exec yarn
yarn install v1.22.21
info No lockfile found.
[1/5] Validating package.json...
[2/5] Resolving packages...
error Error: https://registry.yarnpkg.com/@sentry-internal%2fintegration-shims

@sentry-internal looks like some not open source components that are a mandatory part of your build process. We are still dead in the water for people building the bundles from npm.

@mydea
Copy link
Copy Markdown
Member Author

mydea commented Feb 5, 2024

There is not npm exec yarn anywhere in the instructions, I believe? Not sure where you got this from. If you run yarn install & yarn build as documented it should work. I guess npm probably does not pick up dependencies correctly, this is an internal package that is inside of the monorepo, so that will be resolved by yarn at build time.

@anthonyryan1
Copy link
Copy Markdown

anthonyryan1 commented Feb 5, 2024 •
edited
Loading

Yarn is not part of my build process, so I didn't have it installed globally I ran npm exec yarn to run yarn without installing it globally.

I installed yarn on my workstation globally though, just to match your instructions more precisely.

I can get far enough in yarn && yarn install against git master that it fails on my distro not being ubuntu and failing during @sentry-internal/browser-integration-tests, so I don't believe there's issues against the overall repository.

But the issue in #5108 is about building the code you ship onto npm that can't be used directly any longer.

ar@phenom ~/Projects/website/node_modules/@sentry/browser $ yarn
yarn install v1.22.19
info No lockfile found.
[1/5] Validating package.json...
[2/5] Resolving packages...
error An unexpected error occurred: "https://registry.yarnpkg.com/@sentry-internal%2fintegration-shims: Not found".
info If you think this is a bug, please open a bug report with the information provided in "/home/ar/Projects/website/node_modules/@sentry/browser/yarn-error.log".
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

ar@phenom ~/Projects/website/node_modules/@sentry/browser $ yarn install
yarn install v1.22.19
info No lockfile found.
[1/5] Validating package.json...
[2/5] Resolving packages...
error An unexpected error occurred: "https://registry.yarnpkg.com/@sentry-internal%2fintegration-shims: Not found".
info If you think this is a bug, please open a bug report with the information provided in "/home/ar/Projects/website/node_modules/@sentry/browser/yarn-error.log".
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

ar@phenom ~/Projects/website/node_modules/@sentry/browser $ yarn build
yarn run v1.22.19
error Command "build" not found.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

How do we turn the npm source into a built release that can be used in a project?

@AbhiPrasad
Copy link
Copy Markdown
Contributor

AbhiPrasad commented Feb 5, 2024

Hi @anthonyryan1 - I responded to that entire thread with #5108 (comment). Any comments about the suggestions made there?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Lms24 Lms24 Awaiting requested review from Lms24

1 more reviewer

@AbhiPrasad AbhiPrasad AbhiPrasad approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@mydea mydea

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mydea @anthonyryan1 @AbhiPrasad