Skip to content
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

Upgrade version of Hugo used to build the spec in CI #1794

Merged
merged 3 commits into from
Apr 23, 2024

Conversation

zecakeh
Copy link
Contributor

@zecakeh zecakeh commented Apr 17, 2024

Bumped to Hugo 0.124.1, because there is an incompatibility with docsy in the latest version (0.125.0): google/docsy#1930.

The second commit is a fix for the rendered spec in the render-object-table partial.

The behavior of delimit changed, Hugo doesn't recognize "safe" HTML passed to it anymore, so it escapes nested HTML links even if they were marked as "safe", like this:

image

To fix that we escape the schema data manually and consider the output of the property-type partial as "safe".

I usually do a diff to check if there are visible changes in the rendered spec. Sadly, it seems that the way that URLs are built has changed (most of them are absolute now when they where relative before), so the diff is filled with that. I didn't notice any other change in the rendered spec though.

Preview: https://pr1794--matrix-spec-previews.netlify.app

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
The behavior of `delimit` changed,
so Hugo doesn't recognize "safe" HTML passed to it anymore, so it escapes nested HTML links.

To fix that we escape the schema data manually
and consider the output of the partial as "safe".

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
@zecakeh zecakeh requested a review from a team as a code owner April 17, 2024 11:05
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
@richvdh richvdh merged commit 1095179 into matrix-org:main Apr 23, 2024
12 checks passed
@zecakeh zecakeh deleted the upgrade-hugo branch April 23, 2024 17:08
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.

None yet

2 participants