How to check if upgrading mdbook did not break the generated output?
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 22.2k
- Forks
- 1.9k
- PR merge metrics
- PR metrics pending
Description
Question
Today I upgraded mdbook and some of the plugins I used and generated the HTML pages again.
I looked at the result and it seemed fine, but I started to wonder.
How could I check the output in a more robust way? Maybe do it programmatically?
I guess, I could write some code that would check various things on the pages.
I could generate the output before the upgrade, put it aside and then run a diff on the files after I generated them again with the upgrade. Then I could also look at the diff which would be probably a mess to look at.
How do you check that upgrading mdbook and the various extensions did not negatively impact your book?
Version
mdbook v0.4.52
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the mdBook v0.4.52 upgrade context and the generated HTML output and diff mentioned in the issue. Clarify whether the expected result is documented guidance or an implementation; done would require an agreed, repeatable way to detect regressions after upgrades.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100