docs: conditional breaking changes based on app deployments product update #7401
Conversation
Summary of ChangesHello @adambenhassen, 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 introduces comprehensive documentation for a new feature in Hive that significantly enhances schema checks. The new functionality allows users to identify which active app deployments would be impacted by breaking schema changes, providing crucial insights for impact assessment, team coordination, and risk mitigation before any schema updates are deployed. Highlights
Using Gemini Code AssistThe 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
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds documentation for a new feature that shows which application deployments are affected by breaking schema changes. A new product update post is created, and the main documentation for 'App Deployments' is updated. The changes are clear and well-written. I've made a couple of suggestions in app-deployments.mdx to improve formatting consistency between the two new pieces of documentation.
| - **The deployment** name and version | ||
| - **Which specific operations** within that deployment use the affected schema coordinates |
There was a problem hiding this comment.
The partial bolding in this list is a bit distracting and inconsistent with the corresponding section in the product update post. For better readability, I suggest removing the bolding.
- The deployment name and version
- Which specific operations within that deployment use the affected schema coordinates
| - The breaking change: "Field 'users' was removed from object type 'Query'" | ||
| - Affected app deployment: `mobile-app` version `2.1.0` | ||
| - Affected operations: The specific operation names and hashes that use this field |
There was a problem hiding this comment.
To improve scannability and maintain consistency with the format used in the product update post, consider making the prefixes of these list items bold.
- **The breaking change**: "Field 'users' was removed from object type 'Query'"
- **Affected app deployment**: `mobile-app` version `2.1.0`
- **Affected operations**: The specific operation names and hashes that use this field
📚 Storybook DeploymentThe latest changes are available as preview in: https://pr-7401.hive-storybook.pages.dev |
|
🐋 This PR was built and pushed to the following Docker images: Targets: Platforms: Image Tag: |
1 participant
Background
Description
Checklist