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

init dataconnect:sdk and other SDK onboarding improvements #7299

Merged
merged 7 commits into from
Jun 26, 2024
Merged

Conversation

joehan
Copy link
Contributor

@joehan joehan commented Jun 7, 2024

Description

  • Adds init dataconnect:sdk to help guide users on how to configure their generated SDKs.
  • Calls out this new command at the end of init dataconnect
  • Adds a commented out example of a 'generate' block to the template connector.yaml

Scenarios Tested

I tested out adding SDKs of each type. I also confirmed that if you run this with existing SDKs configured, we default to the values you already have configured.

@joehan joehan marked this pull request as ready for review June 25, 2024 23:53
@joehan joehan requested review from maneesht and fredzqm June 25, 2024 23:53
@joehan joehan changed the title Draft of init dataconnect:sdk init dataconnect:sdk and other SDK onboarding improvements Jun 25, 2024
`Run ${clc.bold("firebase init dataconnect:sdk")} to configure a generated SDK.`,
);
logger.warn(
`See https://firebase.google.com/docs/data-connect/quickstart#configure-sdk-outputs for more details of how to configure generated SDKs.`,
Copy link
Contributor

Choose a reason for hiding this comment

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

@markarndt FYI on the link.

It doesn't work right now. If you have a "future" link, that would be neat.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Dang, this link previously worked, looks like we edited that page recently. Linking to https://firebase.google.com/docs/data-connect/gp/web-sdk instead for now, but feel free to edit suggest a better link @markarndt

@@ -96,6 +99,10 @@ export async function doSetup(setup: Setup, config: Config): Promise<void> {
waitForCreation: false,
});
}
logger.info("");
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you forget to remove this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nope, added this to space out the next message a little better so it is more visible

templates/_gitignore Outdated Show resolved Hide resolved
@@ -85,6 +85,11 @@ choices.push({
name: "Data Connect: Set up a Firebase Data Connect service.",
checked: false,
});
choices.push({
value: "dataconnect:sdk",
name: "Data Connect: Set up a generated SDK for your Firebase Data Connect service.",
Copy link
Contributor

Choose a reason for hiding this comment

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

Data Connect SDK: Set up a generated SDK for your Firebase Data Connect service.

Screenshot 2024-06-25 at 5 28 38 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Followed the pattern used by hosting here, which has 2 init options:
Screenshot 2024-06-25 at 6 05 22 PM

@fredzqm
Copy link
Contributor

fredzqm commented Jun 26, 2024

Did a test run. Looks amazing!

Screenshot 2024-06-25 at 5 33 44 PM

@joehan joehan enabled auto-merge (squash) June 26, 2024 01:11
@joehan joehan merged commit 22bb646 into master Jun 26, 2024
41 checks passed
# swiftSdk:
# outputDir: <Path where you want the generated SDK to be written to, relative to this file>
# kotlinSdk:
# outputDir: <Path where you want the generated SDK to be written to, relative to this file>

Choose a reason for hiding this comment

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

nit: add "package" under "kotlinSdk" to specify the kotlin package to incorporate into the generated kotlin code.

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