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

Adding sentryTag in compose docs #10051

Merged
merged 2 commits into from
Jun 4, 2024
Merged

Adding sentryTag in compose docs #10051

merged 2 commits into from
Jun 4, 2024

Conversation

StefMa
Copy link
Contributor

@StefMa StefMa commented May 16, 2024

DESCRIBE YOUR PR

Changed the docs from mentioning Modifier.testTag to Modifier.sentryTag.
I'm not sure why the testTag thing is there, if this was changed to your own tag or what..
I just found out that you actually use a custom sentryTag and not the testTag.
See https://github.com/getsentry/sentry-android-gradle-plugin/blob/1c15d184114b41058f3c0803c8675b79073f0d0a/sentry-kotlin-compiler-plugin/src/main/kotlin/io/sentry/compose/JetpackComposeTracingIrExtension.kt#L92

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • 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

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

Copy link

vercel bot commented May 16, 2024

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

A member of the Team first needs to authorize it.

Copy link

vercel bot commented May 16, 2024

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 May 28, 2024 6:37pm

@vivianyentran
Copy link
Contributor

@markushi Do you know if testTag was there for a reason?

@markushi markushi requested a review from lizokm May 23, 2024 12:24
@markushi
Copy link
Member

@StefMa thanks for opening up this PR! Yes this is outdated information, as .sentryTag() didn't exist in our initial release. But both .testTag() and .sentryTag() should work: See the implementation for more details.

@StefMa StefMa changed the title Replace testTag with sentryTag in compose docs Adding sentryTag in compose docs May 24, 2024
@StefMa
Copy link
Contributor Author

StefMa commented May 24, 2024

Thanks for the clarification @markushi.
I have committed the changes you suggested.

But let me ask a question:
Would you be more interested in using a sentryTag instead of a testTag? 🤔
Because depending on your answer, we might want to document the testTag as legacy support and focus more on the sentryTag.
However, the advantage of using a testTag is that it doesn't require an additional dependency.

@StefMa
Copy link
Contributor Author

StefMa commented May 28, 2024

@markushi can we get this merged? 😇

@markushi markushi merged commit 47b1413 into getsentry:master Jun 4, 2024
6 checks passed
@markushi
Copy link
Member

markushi commented Jun 4, 2024

Would you be more interested in using a sentryTag instead of a testTag? 🤔

I think this highly depends on your use case, and thus we don't prefer one over the other. E.g. if you heavily use .testTag() already, there's no advantage of "polluting" your code with .sentryTag(). On the other hand, using .sentryTag() makes the usage of the tag more clear.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants