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

Update mdbook and mdbook-i18n-helpers #1658

Merged
merged 1 commit into from
Jan 5, 2024
Merged

Conversation

mgeisler
Copy link
Collaborator

@mgeisler mgeisler commented Jan 5, 2024

This also ports over the mdbook theme changes between version 0.4.35 and 0.4.36.

This also ports over the `mdbook` theme changes between version 0.4.35
and 0.4.36.
@mgeisler mgeisler requested a review from qwandor January 5, 2024 13:56
Copy link
Collaborator

@qwandor qwandor left a comment

Choose a reason for hiding this comment

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

Huh, surprising that a theme change is needed for a patch revision like this, that seems like it should be considered a breaking change.

@@ -8,15 +8,15 @@ runs:
# The --locked flag is important for reproducible builds. It also
# avoids breakage due to skews between mdbook and mdbook-svgbob.
- name: Install mdbook
run: cargo install mdbook --locked --version 0.4.35
run: cargo install mdbook --locked --version 0.4.36
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there a corresponding change needed somewhere else to use this version when building locally?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We tell people to install the latest version and that's normally good enough.

@mgeisler
Copy link
Collaborator Author

mgeisler commented Jan 5, 2024

Hey @qwandor, thanks for the review!

Huh, surprising that a theme change is needed for a patch revision like this, that seems like it should be considered a breaking change.

The theme change is actually backwards compatible — we would just not get the benefits without the theme change. We're probably also a bit unusual in the way that we version one file out of the set of files that make up the theme.

@mgeisler mgeisler merged commit 0e8d3e7 into main Jan 5, 2024
34 checks passed
@mgeisler mgeisler deleted the bump-mdbook-versions branch January 5, 2024 14:56
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.

2 participants