Conversation
Upgrade mdbook from 0.4.52 to 0.5.0, including: - Migrate from monolithic `mdbook` crate to split crates: - `mdbook-core` for core types (Book, BookItem) - `mdbook-preprocessor` for preprocessor API - Update Preprocessor::supports_renderer to return Result<bool> - Replace mdbook-preprocessor-boilerplate with manual implementation - Fix book.toml configuration (remove deprecated `multilingual` field) - Fix unclosed HTML comment in sort.md Note: mdbook-admonish preprocessor is not yet compatible with mdbook 0.5.0 (released Nov 17, 2024). The book build will fail until mdbook-admonish is updated. We're including the configuration to avoid losing it, but expect build failures in CI. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Co-authored-by: Claude <no-reply@anthropic.com>
Member
Author
|
@claude update and resolve conflicts |
|
Claude encountered an error —— View job I'll analyze this and get back to you. |
# Conflicts: # Cargo.lock
- Update mdbook to 0.5.0 in build-web.yaml and tests.yaml - Update mdbook-footnote to 0.2.0 (required for mdbook 0.5.x) - Disable mdbook-admonish until it supports mdbook 0.5.x (see tommilligan/mdbook-admonish#233) The mdbook-prql preprocessor was already updated to use mdbook-preprocessor 0.5.0 in a previous commit. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Convert all 38 admonish blocks to mdbook 0.5.0's native admonition syntax: - `note` (24) → `[!NOTE]` - `info` (8) → `[!NOTE]` - `warning` (5) → `[!WARNING]` - `example` (1) → `[!NOTE]` with "For example" prefix This removes the dependency on mdbook-admonish, which doesn't yet support mdbook 0.5.0 (see tommilligan/mdbook-admonish#233). Also removes mdbook-admonish.css from book.toml since we no longer need it. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
for more information, see https://pre-commit.ci
- Upgrade pulldown-cmark from 0.10.3 to 0.13.0 (includes GFM blockquote tag support for admonitions) - Upgrade pulldown-cmark-to-cmark from 14.0.1 to 21.1.0 (compatible with pulldown-cmark 0.13) - Fix admonition markdown syntax: `[!NOTE]` must be on its own line, not inline with content (e.g., `> [!NOTE]\n> content` not `> [!NOTE] content`) - Add test for admonition round-tripping through preprocessor 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
for more information, see https://pre-commit.ci
Now that we're on mdbook 0.5.x with native admonitions, we can use the latest versions without version pinning. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
The check-links-book job was failing because it tried to build the book without installing mdbook-footnote, which is required by book.toml. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
The shell completion output changed due to an updated clap dependency. Updated snapshots for bash, fish, zsh, and powershell completions. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
The shell completion test snapshots expect the new clap shell completion format (with BASH_VERSINFO checks), which requires a newer clap version. This fixes the test-deps-min-versions CI job. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Upgrades mdbook from 0.4.52 to 0.5.0 (released Nov 17, 2024).
Changes
mdbookcrate into specialized cratesmdbook-corefor core types (Book, BookItem, Config)mdbook-preprocessorfor the Preprocessor APIsupports_renderer()now returnsResult<bool>instead ofboolmdbook-preprocessor-boilerplate(not yet updated) and implemented the preprocessor CLI manuallymultilingualfield from book.tomlsort.mdKnown Issues
mdbook-admonish(v1.20.0) has not yet been updated for mdbook 0.5.0. The preprocessor is included in the configuration to avoid losing it, but the book build will fail until mdbook-admonish releases a compatible version.This PR upgrades our code to be ready for when the ecosystem catches up.
Test Plan
🤖 Generated with Claude Code