Skip to content

Readme fixes#10105

Merged
christhompsongoogle merged 5 commits intomainfrom
readmeNonClobber
Mar 16, 2026
Merged

Readme fixes#10105
christhompsongoogle merged 5 commits intomainfrom
readmeNonClobber

Conversation

@christhompsongoogle
Copy link
Contributor

Update content, renamed the cleanup workflow, avoid clobbering existing README if it exists.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request streamlines the migration process from Firebase Studio to Antigravity by updating the generated README.md to be more informative and relevant to the new environment. It also refactors internal migration logic for cleaner code and renames the post-migration workflow for better clarity on its purpose.

Highlights

  • README Content Update: Updated the content and structure of the generated README.md for migrated projects, providing a new welcome message and clearer getting started instructions for Antigravity.
  • Migration Logic Refactoring: Refactored the migration logic to remove the blueprintContent parameter, simplifying the extractMetadata and updateReadme functions.
  • Workflow Renaming and Update: Renamed the startup_workflow.md template to cleanup.md and updated its content to focus on post-migration cleanup steps.
  • Template Simplification: Removed the appName placeholder from the readme_template.md and simplified the system_instructions_template by removing the projectId replacement.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • src/firebase_studio/migrate.spec.ts
    • Updated the expected content for readme_template.md in tests to reflect the new template structure.
  • src/firebase_studio/migrate.ts
    • Removed blueprintContent from the return type of extractMetadata.
    • Removed blueprintContent and appName parameters from updateReadme function signature.
    • Simplified the newReadme content generation by removing appName and blueprintContent replacements.
    • Removed projectId replacement from systemInstructions generation.
    • Updated the migrate function call to extractMetadata and updateReadme to reflect the removed parameters.
  • templates/firebase-studio-export/readme_template.md
    • Completely revised the README template to welcome users to Antigravity, provide detailed getting started instructions, and remove the previous appName and blueprintContent sections.
  • templates/firebase-studio-export/workflows/cleanup.md
    • Added a new workflow template for post-migration cleanup steps, including checks for compilation, Genkit config, and dev.nix.
  • templates/firebase-studio-export/workflows/startup_workflow.md
    • Removed the old startup_workflow.md template.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request refactors the Firebase Studio to Antigravity migration by removing the blueprintContent concept and updating the readme_template.md to a new welcome message. It also introduces a cleanup.md workflow file, replacing an older workflow. A bug was noted where src/firebase_studio/migrate.ts still attempts to read the deleted startup_workflow.md file within injectAntigravityContext, which should be updated to use the new cleanup.md file to prevent silent failures.

I am having trouble creating individual review comments. Click here to see my feedback.

templates/firebase-studio-export/workflows/startup_workflow.md (1-12)

high

This file has been deleted, but src/firebase_studio/migrate.ts still attempts to read it inside the injectAntigravityContext function. This will cause the workflow creation step to fail silently. You should update the code to read from the new workflows/cleanup.md file and write to cleanup.md in the destination.

This project was migrated from Firebase Studio.
**Previous Name:** ${appName}
**Export Date:** ${exportDate}
Welcome to your new developer home! Your Firebase Studio project has been successfully migrated to Antigravity.
Copy link
Member

Choose a reason for hiding this comment

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

Should we get @jesskuras to take a pass over this, or did this already get tech writer attention?

Copy link
Member

@joehan joehan left a comment

Choose a reason for hiding this comment

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

Lint, but lgtm otherwise

@christhompsongoogle christhompsongoogle enabled auto-merge (squash) March 16, 2026 17:28
@christhompsongoogle christhompsongoogle merged commit c21c1fb into main Mar 16, 2026
47 checks passed
@christhompsongoogle christhompsongoogle deleted the readmeNonClobber branch March 16, 2026 17:41
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.

3 participants