[Buganizer ID: 463991564]GitSync playbook description with line breaks cause issues with readme file #393
Conversation
… readbility of readme
Summary of ChangesHello @jayapradha-p, 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 resolves a critical formatting bug within the GitSync integration. Previously, playbook descriptions containing line breaks would cause the generated README file's playbook table to render incorrectly. The solution involves sanitizing these descriptions by removing all newline and carriage return characters, thereby ensuring that the README's table structure remains intact and properly aligned, enhancing the readability and presentation of playbook information. Highlights
🧠 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. 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
|
|
❌ Marketplace Validation Failed Click to view the full reportValidation Report🧩 IntegrationsPre-Build Stagegit_sync
|
![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 fixes an issue where newlines in playbook descriptions were breaking the formatting of generated README files. The change correctly removes these newlines. However, the implementation introduces a side effect by modifying shared data objects, which could lead to incorrect behavior in other parts of the application. I've provided a suggestion to resolve this by using a more robust and idiomatic Python approach that avoids data mutation. The other changes are version bumps and look good.
content/response_integrations/power_ups/git_sync/jobs/PushPlaybook.py
Outdated
Show resolved
Hide resolved
|
❌ Marketplace Validation Failed Click to view the full reportValidation Report🧩 IntegrationsPre-Build Stagegit_sync
|
4 participants
[Buganizer ID: 463991564]GitSync playbook description with line breaks cause issues with readme file
Description
Please provide a detailed description of your changes. This helps reviewers understand your work and its context.
What problem does this PR solve?
When the "Push Playbook" job is run from the "GitSync" integration using the "Jinja" readme template, the table formatting in the resulting readme file breaks if any playbook contains line breaks.
This results in the table listing the playbooks in the README becoming broken or misaligned.
How does this PR solve the problem?
The fix removes these line breaks from the description text before the README is generated, ensuring each playbook's information remains on a single line and the table aligned correctly.
Checklist:
Please ensure you have completed the following items before submitting your PR.
This helps us review your contribution faster and more efficiently.
General Checks:
Open-Source Specific Checks:
For Google Team Members and Reviewers Only:
Screenshots (If Applicable)
If your changes involve UI or visual elements, please include screenshots or GIFs here.
Ensure any sensitive data is redacted or generalized.
Further Comments / Questions
Any additional comments, questions, or areas where you'd like specific feedback.