[Doc] Support consistency check for API reference in CI #1655
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
Signed-off-by: rudeigerc <rudeigerc@gmail.com>
kevin85421
reviewed
Nov 17, 2023
There was a problem hiding this comment.
Thank you for your contribution! Would you mind opening a PR as a control group to ensure that the CI can detect any inconsistencies and fail accordingly? You can use this PR as an example: #577 (comment).
rudeigerc
added a commit
to rudeigerc/kuberay
that referenced
this pull request
Nov 18, 2023
Signed-off-by: rudeigerc <rudeigerc@gmail.com>
|
Hi, I've imported the control group test in #1661.
|
kevin85421
approved these changes
Nov 18, 2023
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.
Why are these changes needed?
This pull request adds support for consistency check of API reference in CI.
Besides, it ignores additional types related to
RayClusterStatusinhack/config.yaml./cc @kevin85421
Related issue number
It's a subsequent pull request of #1625.
Checks
docs/reference/api.mdis outdated with the current config. The workflow is expected to fail. Here is the result.