Make all prdoc valid and add CI job to check prdoc with prdoc check
#7543
+8
−257
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
gui1117
commented
Feb 11, 2025
alvicsam
reviewed
Feb 11, 2025
Co-authored-by: Alexander Samusev <41779041+alvicsam@users.noreply.github.com>
alvicsam
reviewed
Feb 12, 2025
Co-authored-by: Alexander Samusev <41779041+alvicsam@users.noreply.github.com>
alvicsam
approved these changes
Feb 13, 2025
mordamax
approved these changes
Feb 13, 2025
bkchr
reviewed
Feb 13, 2025
.github/workflows/checks-quick.yml
Outdated
| timeout-minutes: 20 | ||
| steps: | ||
| - uses: actions/checkout@6d193bf28034eafb982f37bd894289fe649468fc # v4.1.7 | ||
| - name: prdoc check |
There was a problem hiding this comment.
Why isn't that just part of the CheckPrdoc job?
There was a problem hiding this comment.
I thought it would be similar to fmt.
But I refactored and put inside the CheckPrdoc: basically it was ignoring errors when R0-silent, I make the check mandatory: 5013295
gui1117
force-pushed
the
gui-fix-prdoc
branch
from
d891ac9 to
fc47748
Compare
gui1117
force-pushed
the
gui-fix-prdoc
branch
from
fc47748 to
5013295
Compare
alvicsam
reviewed
Feb 14, 2025
| echo "PR detected as silent, but a PRDoc was found, checking it as information" | ||
| $ENGINE run --rm -v $PWD:/repo $IMAGE check -n ${GITHUB_PR} || echo "Ignoring failure" | ||
| echo "PR detected as silent, but a PRDoc was found, checking it" | ||
| $ENGINE run --rm -v $PWD:/repo $IMAGE check -n ${GITHUB_PR} |
There was a problem hiding this comment.
This step checks only if there is a PRdoc for this PR and validates it. If the idea was to check all existing prdocs I'd suggest adding an additional job check-prdoc-all that will check all prdocs.
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.
Some prdoc are invalid,
prdoc checkis failing for them. This also broke usage of parity-publish.This PR fixes the invalid prdoc, and add a ci job to check the prdoc are valid. I don't think the check is unstable considering it is a simple yaml check, so I put the job as required.