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

(Capacitor): Add migration guide for new version #10987

Merged
merged 3 commits into from
Aug 26, 2024

Conversation

lucas-zimerman
Copy link
Collaborator

@lucas-zimerman lucas-zimerman commented Aug 5, 2024

DESCRIBE YOUR PR

The next major version of Sentry Capacitor will also use Sentry Javascript SDK V8 where both includes break changes, this PR aims to add a migration guide for both Capacitor and the Sibling SDKs.

I also removed the deprecated setup of Capacitor 2 that we will no longer support and also a small refactor on v8-new-performance-api to make the file smaller to read on the code review.

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

I checked that locally it is building and displaying correctly.

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 (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

EXTRA RESOURCES

Copy link

vercel bot commented Aug 5, 2024

@lucas-zimerman is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

@lucas-zimerman
Copy link
Collaborator Author

@krystofwoldrich @kahest

Should I also add an information like this? https://docs.sentry.io/platforms/javascript/guides/angular/#angular-version-compatibility

despite the page mentioning that older versions of Angular should use V7, the docs only only shows the documentation of V8 so it may generate confusion to users sticking with V7.

Our Capacitor SDK only supports Angular as low as 10, so we could mention that users should stick with Capacitor V0 for Angular 10 to - 13 and V1 for Angular 14 or higher.

Copy link

vercel bot commented Aug 14, 2024

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

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 16, 2024 0:36am
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 16, 2024 0:36am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Aug 16, 2024 0:36am

@kahest
Copy link
Member

kahest commented Aug 14, 2024

@chargome I added @getsentry/team-web-sdk-frontend as reviewer - please rope in other reviewers if needed 🙏

@kahest
Copy link
Member

kahest commented Aug 14, 2024

@krystofwoldrich @kahest

Should I also add an information like this? docs.sentry.io/platforms/javascript/guides/angular#angular-version-compatibility

despite the page mentioning that older versions of Angular should use V7, the docs only only shows the documentation of V8 so it may generate confusion to users sticking with V7.

Our Capacitor SDK only supports Angular as low as 10, so we could mention that users should stick with Capacitor V0 for Angular 10 to - 13 and V1 for Angular 14 or higher.

Yes I think that would help users understand 👍

@krystofwoldrich
Copy link
Member

Besides the Angular versions mentioned above, the guide migration guide looks good!

Copy link
Member

@lforst lforst left a comment

Choose a reason for hiding this comment

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

Thanks!

Copy link
Member

@krystofwoldrich krystofwoldrich left a comment

Choose a reason for hiding this comment

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

Looks good! Thank you! 🚀

@lforst lforst merged commit 58ff6df into getsentry:master Aug 26, 2024
9 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Sep 11, 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.

4 participants