feat: Add --saas CLI arg to skip self-hosted or SaaS selection step
#678
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Lms24
commented
Sep 26, 2024
| @@ -60,6 +60,11 @@ const argv = yargs(hideBin(process.argv)) | |||
| alias: 'url', | |||
| describe: 'The url to your Sentry installation\nenv: SENTRY_WIZARD_URL', | |||
| }) | |||
| .option('saas', { | |||
There was a problem hiding this comment.
I noticed we didn't add --project and --org to this list. @obostjancic was this on purpose? If not, I'll quickly add it. This ensures that --help lists the two options in the help message.
There was a problem hiding this comment.
I also noticed that it's missing from the readme file
There was a problem hiding this comment.
Good point. I think the readme was generally a bit outdated. I updated it, along with adding --project and --org to the readme and --help output in a follow-up PR: #679
obostjancic
approved these changes
Sep 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, our in-product onboarding shows the
--urloption because we want to skip the "Are you using Sentry.io or self-hosted" question (in-product, we already know the URL).From the wizard perspective, we default to the SaaS url if users don't pass a custom
--url. However, if users pass a custom URL that is the SaaS URL we unnecessarily injecturlparams into code where it's not strictly necessary.The new
--saasflag introduced in this PR will skip over the self-hosted question and if it's set totrueassume that users are using SaaS. We can display--saasin the UI (for SaaS) instead of--url, making the snippet a bit shorter and avoiding to unnecessarily inject theurlparams into user code.