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 hugo #27679

Merged
merged 2 commits into from
Jun 17, 2024
Merged

Upgrade hugo #27679

merged 2 commits into from
Jun 17, 2024

Conversation

arusahni
Copy link
Contributor

Motivation

  • This PR adds a feature that has not yet been specified.

Our current version of Hugo is fairly out of date, and engineers are encountering issues trying to author docs. This upgrades us to a recent version of Hugo and makes the necessary changes to make the generated docs functional. Beyond the version bump this includes:

  • Fixing a build issue around the footer object format changing
  • Updating our path generation to account for a change in relative pathing. Newer versions of Hugo generate URLs relative to the host, not subdirectory, even when hosted within a subdirectory. Add logic to our templates shortcodes to read the path from the Hugo config and prepend it to any relative URL.

Tips for reviewer

Checklist

`.File` can potentially be nil on pages that can't be mapped to a file
(e.g., directories without an `_index.md`), so add a guard around the
GitHub docs link in the footer.
Newer versions of Hugo (>0.87) changed how relative URLs are generated.
These new URLs cause surprising behavior when hosted within a
subdirectory. Add logic to our link and image shortcodes to read the
path from the Hugo config and prepend it to any relative URL.
@arusahni arusahni requested review from morsapaes and a team as code owners June 14, 2024 17:35
@arusahni arusahni requested review from a team and removed request for a team June 14, 2024 18:33
Copy link
Contributor

@def- def- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No complaints from QA side

Copy link
Contributor

@morsapaes morsapaes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for trudging through this, @arusahni. ❤️

@arusahni arusahni merged commit 7541e41 into MaterializeInc:main Jun 17, 2024
85 checks passed
@arusahni arusahni deleted the chore/upgrade-hugo branch June 17, 2024 15:04
benesch added a commit to benesch/materialize that referenced this pull request Jun 27, 2024
The upgrade to Hugo v0.124.1 in MaterializeInc#27679 has broken the deploy_website
build. The issue appears to be a bug in the Go AWS SDK version that Hugo
v0.124.1 uses that causes credential refreshing to sporadically fail.
The latest version of Hugo (v0.128) incoporates a Go AWS SDK upgrade
that hopefully fixes the issue.
@benesch benesch mentioned this pull request Jun 27, 2024
5 tasks
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

3 participants