chore: use mdcode to avoid bitrot in README #1172
Merged
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
Open
[mdcode](https://github.com/szkiba/mdcode) is a tool that allows code snippets in Markdown files to be tested. This PR uses it to test that the instructions in the README don't bitrot. We can/should use this to ensure the instructions in our future documentation stays current. This required changes to how the controller reports active deployments, some minor refactoring, and adding functionality to the controller that allows it to report readiness only once a set of modules are deployed.
alecthomas
force-pushed
the
aat/test-readme
branch
from
3910af6 to
1a93f4f
Compare
|
Awesome that's @alecthomas, cool concept! I'll check it out. PR works for me now. Thanks for that! Keen to start looking into it. |
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.
mdcode is a tool that allows code snippets in Markdown files to be tested. This PR uses it to test that the instructions in the README don't bitrot.
We can/should use this to ensure the instructions in our future documentation stay current.
This required changes to how the controller reports active deployments, some minor refactoring, and adding functionality to the controller that allows it to report readiness only once a set of modules are deployed.