feat: Add support for a dry run option for ci environments #188 #288
Conversation
This file contains hidden or 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
thompson-tomo
changed the title
AndrewSouthpaw
approved these changes
Dec 8, 2025
Collaborator
AndrewSouthpaw
left a comment
AndrewSouthpaw
left a comment
There was a problem hiding this comment.
Just a few nits! Thanks.
thompson-tomo
force-pushed
the
feature/#188_dryrun-option
branch
from
b2e6f2f to
384954e
Compare
Co-authored-by: Andrew Smith <[email protected]>
thompson-tomo
force-pushed
the
feature/#188_dryrun-option
branch
from
384954e to
91f35e1
Compare
Contributor
Author
|
@AndrewSouthpaw the changes have been made. Is there anything else needed from me for this PR? |
AndrewSouthpaw
approved these changes
Dec 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #188
Closes #169
This introduces a dry run option which rather than writing changes to the files instead returns an exit code of 1. This exit code can then be used in ci environments to fail a release/build due to out of date documentation.
Note this corrects the check to see if a TOC needs to be transformed as indicated in #169 and as such that pr should be closed.