Readme: Be specific about requiring Hugo 0.113.0 to build the spec #1587
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Yes, please add this note. I'm maintaining the Matrix spec for the Dash offline documentation viewer: |
akirk
changed the title
|
I am afk but if it's fixed I'm ok to just close this one. |
|
Thanks for the contribution anyway! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The GHA workflow is pinned at 0.93.3 and the spec won't build in recent versions of Hugo, see #1586.
Until that error is resolved in modern versions, the building instructions should guide contributors to be able to build a working version and not run into errors when trying to build it.
While building the spec in more modern hugo versions than 0.93.3 is possibe (I successfully tested with 0.113, see #1586), the build process with that version is proven through the Github Actions and thus reflects the currently safest path to get the spec built locally (without using docker). There is at least one known issue with newer versions (#1544).
Signed-off-by:
Alex Kirk <[email protected]>Preview: https://pr1587--matrix-spec-previews.netlify.app