tools: add doc diff #1188
Merged
tools: add doc diff #1188
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
camshaft
force-pushed
the
camshaft/docdiff
branch
10 times, most recently
from
e8664b9 to
71f16c1
Compare
camshaft
force-pushed
the
camshaft/docdiff
branch
from
71f16c1 to
27fae1b
Compare
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.
Description of changes:
This change adds a
docdifftool to track public API changes with a.snapfile. The tool generates the crate documentation withcargo docand scrapes the HTML files for all of the exported structs, enums, traits, etc. and compares it against theapi.snapfile in the crate. This will ensure nothing in the public API changes without an explicitcargo insta review.I tried getting semverver to work but it panicked in a few places and doesn't seem actively maintained (See #18)
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.