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

[Vertex AI] Add README for unit test mock files #13233

Merged
merged 3 commits into from
Jul 5, 2024

Conversation

andrewheard
Copy link
Contributor

Added a README.md with instructions for running the update_vertexai_responses.sh script. This file was also added as a resource in the FirebaseVertexAIUnit testTarget ensuring that a Bundle.module will always be generated by Swift Package Manager. This prevents the following build error if the script has not yet been run:
Bundle.module Error Screenshot

#no-changelog

Copy link
Contributor

@tanzimfh tanzimfh left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

Maybe the text in README.md#firebase-vertex-ai should be replaced with a link to this README?

And should we add the script to scripts/README.md as well?

@andrewheard
Copy link
Contributor Author

Maybe the text in README.md#firebase-vertex-ai should be replaced with a link to this README?

Agreed. Also I think people are more likely to land on the README in the top-level FirebaseVertexAI directory so I've moved this new content into there. I updated the README in the Unit subdirectory to link to it as well -- easier to maintain if it's all in one place. I should also add a section for the integration tests but will leave that for a follow-up PR.

And should we add the script to scripts/README.md as well?

Good catch, @tanzimfh! Added one there.

@andrewheard andrewheard merged commit 18db6d8 into main Jul 5, 2024
62 checks passed
@andrewheard andrewheard deleted the ah/vertex-tests-readme branch July 5, 2024 20:34
@firebase firebase locked and limited conversation to collaborators Aug 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants