-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Remove skipTemplateRendering from release notes front matter
#12661
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
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello @iakdis, 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 addresses a critical templating malfunction affecting numerous release notes and changelog pages. By systematically removing a specific front matter directive, 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
|
There was a problem hiding this 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 removes the skipTemplateRendering: true property from the front matter of numerous release note and changelog markdown files. This change is intended to fix an issue where a template snippet for a repository link was not being rendered correctly. The change is applied consistently across all relevant files and directly addresses the problem described. The implementation is straightforward and correct, and I have no specific comments on the changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for noticing this and opening a PR to fix the issue.
Unfortunately, there's a performance issue with the Liquid templating package that we use that results in these pages taking too long to render with it. Since we haven't got around to fixing it yet, we'll need to keep skipping this for now.
Instead of doing this, could you instead replace the usage of the Liquid variables on these pages with the underlying values? I think it's fine if these usages aren't configurable.
|
I see, thank you for the information @parlough! I have reverted the changes and added a new commit which replaces the Liquid variables used on these pages according to the variable defined in |
|
/gcbrun |
|
Visit the preview URL for this PR (updated for commit b4cf0af): |
parlough
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks again for noticing this and fixing this! I really appreciate :D
The problem that is described in the linked issue seems to occur due to the
Templating system not working for the snippet `{{site.repo.flutter}}`.
What differentiates the release notes pages from others is the option
`skipTemplateRendering` in the front matter, which is set to `true`.
Fix this by replacing the usage of template variables with the underlying values.
Fixes #12660
Description of what this PR is changing or adding, and why: The problem that is described in the linked issue seems to occur due to the Templating system not working for the snippet
{{site.repo.flutter}}. What differentiates the release notes pages from others is the optionskipTemplateRenderingin the front matter, which is set totrue. While testing, removing the option from the front matter makes the link open as expected.Issues fixed by this PR (if any): #12660
PRs or commits this PR depends on (if any):
Presubmit checklist
of 80 characters or fewer.