Repository navigation
ci: test the documentation examples, add the changelog - #13
Merged
Merged
Conversation
- tests/Docs: every example of the Markdown pages that shows the arguments (or the exception) of a query is run and compared; links, anchors and the list of documented methods are checked too - UPDATE_DOCS=1 vendor/bin/pest --group=docs rewrites the outputs after a deliberate change - CI: the documentation examples run as their own step - CHANGELOG.md for 2.0.0
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Stacked on #12.
Documentation tests (
tests/Docs, groupdocs)UPDATE_DOCS=1 vendor/bin/pest --group=docsrewrites the outputs after a deliberate changeI checked that they fail when they should: a wrong output in a page, a behaviour change in the code, a broken link and a new undocumented public method each fail the suite, and the update mode restores the page byte for byte.
CI: the examples run as their own step (
--group=docs), the other tests run with--exclude-group=docs.CHANGELOG.md: the 2.0.0 entry (unreleased), in line with
docs/upgrading.md. A major version is suggested: public methods are removed and some fixes change the results of existing queries.Pest: 317 passed (242 + 75 documentation).