-
-
Notifications
You must be signed in to change notification settings - Fork 84
Fix GitHub Pages workflow #275
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
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.
Pull request overview
This PR attempts to fix the GitHub Pages workflow by enabling Jekyll's Liquid template processing, but the implementation is incomplete and introduces critical issues. The key changes include fixing YAML indentation in _config.yml, removing the render_with_liquid: false setting, adding {% raw %} tags to protect one Twig code block from Liquid processing, adding a temporary pull_request trigger to the workflow, and configuring proper YAML indentation in .editorconfig.
Key Issues
- The removal of
render_with_liquid: falseenables Liquid processing across all markdown files, but only one of five Twig code blocks intemplate-engines.mdis protected with{% raw %}tags - The workflow includes a temporary pull_request trigger marked for removal but left in the PR
- The incomplete migration will likely cause Jekyll build failures when Liquid attempts to process unprotected Twig syntax
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| _config.yml | Fixed YAML indentation but removed render_with_liquid: false, enabling Liquid processing that requires protecting all Twig syntax |
| guide/en/views/template-engines.md | Added {% raw %}/{% endraw %} tags to one Twig code block, but four other blocks with similar syntax remain unprotected |
| .github/workflows/jekyll-gh-pages.yml | Added temporary pull_request trigger (marked for removal) and removed comment lines |
| .editorconfig | Added proper 2-space indentation configuration for YAML files |
| values: | ||
| render_with_liquid: false | ||
| - scope: | ||
| path: "" |
Copilot
AI
Dec 20, 2025
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.
The render_with_liquid: false configuration has been removed from _config.yml. However, this setting was likely intentional to prevent Jekyll/Liquid from processing Markdown files that contain Twig syntax (which uses similar {{ }} and {% %} delimiters). Removing this setting means Jekyll will now try to process all Liquid-like syntax in the documentation.
While the PR adds {% raw %} tags to one specific code block in template-engines.md, there are multiple other Twig code blocks in the same file (lines 19-43, 49-55, 75-87, 90-99) that also contain Liquid-like syntax but are NOT wrapped in {% raw %} tags. These will now be processed by Jekyll and potentially cause build errors or incorrect rendering.
Either the render_with_liquid: false setting should be kept, or ALL Twig code blocks throughout the documentation need to be wrapped with {% raw %}/{% endraw %} tags.
| path: "" | |
| path: "" | |
| values: | |
| render_with_liquid: false |
|
|
||
| on: | ||
| # Runs on pushes targeting the default branch | ||
| pull_request: # TEMPORARY !!! |
Copilot
AI
Dec 20, 2025
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.
The pull_request trigger is marked as "TEMPORARY !!!" but should be removed before merging to production. This trigger will cause the workflow to run on all pull requests, which is generally not desired for a GitHub Pages deployment workflow. Deployment to GitHub Pages should typically only happen on push to the main branch or via manual workflow_dispatch.
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.
Pull request overview
Copilot reviewed 11 out of 11 changed files in this pull request and generated 6 comments.
# Conflicts: # .github/workflows/jekyll-gh-pages.yml # _config.yml
| @@ -1,3 +1,7 @@ | |||
| --- | |||
| render_with_liquid: false | |||
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.
I think it's better to disable Liquid globally at config level because front matter is rendered at GitHub: 787e837
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.
Agree, added.
|
Closed in favor #276 |
No description provided.