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

test scripts to compare mdbook version output #778

Closed

Conversation

rbuckland
Copy link
Contributor

@rbuckland rbuckland commented Sep 3, 2018

This PR adds some BASH scripts that forcibly test 2 configurable branch versions of mdbook with all the rust-lang-nursery/* and rust-lang/* book.toml repos *(finds them via github API search).

The tests/mdbook_version_validator/README.md has a LOT more information.

but in short, these scripts are good for running two separate versions (build by the scripts) of mdbook, and compiling a list of books, and checking for any differences - and reporting.

The scripts are NOT run as part of cargo test, they are just BASH scripts to give some level of confidence for current (smart-preprocessor) and future changes.

This is for PR #658

@Michael-F-Bryan
Copy link
Contributor

This is pretty cool! I imagine they'd be useful when checking for regressions or trying to reproduce an issue.

What are your thoughts on putting the README.md in the user guide under the for developers section? Technically it's for mdbook developers and not developers of 3rd party plugins, but being in the user guide will probably make the scripts more discoverable.

@rbuckland
Copy link
Contributor Author

Yes - good idea. I will

  • - Add a config file, allowing users to add their "books" to the config for searching. (either org or direct repo with book.toml)
  • - Add some documentation, making the feature aware so other can register their - dependency / interest

It would be good to rewrite the test as rust - (as an excercise). (later)

@rbuckland
Copy link
Contributor Author

Am closing this PR, creating a new one from the "test scripts branch"

https://github.com/rbuckland/mdBook/tree/feature/other-books-test-scripts

@rbuckland rbuckland closed this Sep 9, 2018
@rbuckland
Copy link
Contributor Author

New PR created as #786

@rbuckland rbuckland deleted the smart-preprocessor branch September 9, 2018 01:20
@rbuckland rbuckland restored the smart-preprocessor branch September 9, 2018 01:21
@rbuckland rbuckland deleted the smart-preprocessor branch September 9, 2018 01:21
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