Add cargo semver-checks testsuite to rustdoc JSON output · Issue #110815 · rust-lang/rust (original) (raw)

Skip to content

Navigation Menu

• • GitHub Copilot Write better code with AI
  • GitHub Advanced Security Find and fix vulnerabilities
  • Actions Automate any workflow
  • Codespaces Instant dev environments
  • Issues Plan and track work
  • Code Review Manage code changes
  • Discussions Collaborate outside of code
  • Code Search Find more, search less
• Explore
  • Learning Pathways
  • Events & Webinars
  • Ebooks & Whitepapers
  • Customer Stories
  • Partners
  • Executive Insights
• • GitHub Sponsors Fund open source developers
  • The ReadME Project GitHub community articles
• • Enterprise platform AI-powered developer platform
• Pricing

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sign up

Appearance settings

Description

Rustdoc has a ... not-very-comprensive test suite. cargo-semver-checks has much more extensive tests. It would be really nice if we could test that we don't accidentally regress the JSON output (or the other output for that matter; I suspect most breakage affects both backends).

I think the easiest way to do this is to add a new tests/rustdoc-semver-checks submodule with a dependency on https://github.com/obi1kenobi/cargo-semver-checks. Then in src/bootstrap/test.rs, we'll add a new test suite that runs cargo test on cargo-semver-checks using the in-tree version of rustdoc to make sure there's no incompatibilities.

I am not sure how this should deal with breaking changes to the JSON format - maybe we can use toolstate which allows the tests to be broken until semver-checks supports the new version?

cc @obi1kenobi @rust-lang/rustdoc