Skip to content
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.

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

Disable sourceContext option to make build work. #8497

Merged
merged 5 commits into from
Jan 12, 2024

Conversation

Glyphack
Copy link
Contributor

@Glyphack Glyphack commented Nov 15, 2023

Changes

  • Disable sourceContext option to make build work: This option was set to true in example config but this option cannot be enabled without setting org, project, and authToken so in result the config you copy from the docs fail. I think adding the comment to enable it after reading the docs would communicate that some additional steps are needed for this feature.
  • Add section for specifying dependencies of sentry task: When running the plugin in a build where there is a code generation task, the plugin fails. This section provides guidance for running sentry plugin step after the code generation tasks.

Fix: getsentry/sentry-android-gradle-plugin#546

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

Describe your changes here. If your PR relates to or resolves an issue, add a link to that too.

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

Extra resources

When setting this option to true, `authToken`, `org`, and `project` settings also need to be set. Documentation for setting them exists in the source context documentation.
Copy link

vercel bot commented Nov 15, 2023

@Glyphack is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

@Glyphack Glyphack marked this pull request as ready for review December 6, 2023 18:06
@Glyphack Glyphack requested a review from a team as a code owner December 6, 2023 18:06
@Glyphack
Copy link
Contributor Author

Hi @adinauer I tried to add the resolution in the issue getsentry/sentry-android-gradle-plugin#546 to docs here. Could you take a look since you have more context about this feature?

I'm not totally sure this PR will fix that issue because the discussion drifted away from the source upload to code mappings and was left there. But this adjustments are useful for others trying to use this feature.

@adinauer
Copy link
Member

Thanks for the PR @Glyphack.

I'd prefer to keep the sample with sourceContext enabled but I do agree it should be more clear that other settings are required as well to enable it.

I feel like the sentence you added should go into troubleshooting but in general makes sense to add it to the docs. Thank you!

We'll discuss internally and update the PR if you don't mind.

Copy link

vercel bot commented Dec 20, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 12, 2024 10:08am
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
sentry-docs-next ⬜️ Ignored (Inspect) Visit Preview Jan 12, 2024 10:08am

@getsantry
Copy link
Contributor

getsantry bot commented Jan 11, 2024

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you remove the label Waiting for: Community, I will leave it alone ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

@getsantry getsantry bot added the Stale label Jan 11, 2024
@adinauer adinauer removed the Stale label Jan 11, 2024
Copy link
Contributor

@shanamatthews shanamatthews left a comment

Choose a reason for hiding this comment

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

LGTM, just a couple of small grammar tweaks.

src/platform-includes/source-context/java.mdx Outdated Show resolved Hide resolved
src/platform-includes/source-context/java.mdx Outdated Show resolved Hide resolved
src/platforms/java/common/gradle/index.mdx Outdated Show resolved Hide resolved
src/platforms/java/common/gradle/index.mdx Outdated Show resolved Hide resolved
adinauer and others added 2 commits January 12, 2024 08:58
Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>
@adinauer adinauer merged commit b30ad5c into getsentry:master Jan 12, 2024
8 of 9 checks passed
@adinauer
Copy link
Member

Thanks again @Glyphack for the contribution!

@Glyphack Glyphack deleted the update-gradle-plugin-docs branch January 12, 2024 10:53
@github-actions github-actions bot locked and limited conversation to collaborators Jan 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Synchronize GitHub Source Code Mappings to Java Build Tool Model
3 participants