Make all prdoc valid and add CI job to check prdoc with prdoc check
#7543
Conversation
Co-authored-by: Alexander Samusev <[email protected]>
Co-authored-by: Alexander Samusev <[email protected]>
.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
.github/workflows/check-prdoc.yml
Outdated
| 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.
There was a problem hiding this comment.
yes, in this commit I refactor to just check for all prdoc:
6930f83
gui1117
added
R0-silent
|
Needs one more approval from @paritytech/core-devs Edit: Sorry for the spam, I somehow thought it was only frame coders |
|
|
||
| - name: Validate prdoc for PR#${{ github.event.pull_request.number }} | ||
| if: ${{ !contains(steps.get-labels.outputs.labels, 'R0') }} | ||
| if: ${{ github.event.pull_request.number != '' && !contains(steps.get-labels.outputs.labels, 'R0') }} |
There was a problem hiding this comment.
There could be R0 with PR doc. Maybe we should also validate it?
There was a problem hiding this comment.
Yes true, but at the same time R0 means it doesn't show in the changelog so change should be minor.
…paritytech#7543) Some prdoc are invalid, `prdoc check` is 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. --------- Co-authored-by: Alexander Samusev <[email protected]>
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.