mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-25 18:47:56 +00:00
Oliver Tale-Yazdi
4080632ee0
Changes: - Add CI script to check that the `crate` names that are mentioned in prdocs are valid. We can extend it lateron to also validate the correct SemVer bumps as introduced in https://github.com/paritytech/polkadot-sdk/pull/3441. Example output: ```pre $ python3 .github/scripts/check-prdoc.py Cargo.toml prdoc/*.prdoc 🔎 Reading workspace polkadot-sdk/Cargo.toml. 📦 Checking 36 prdocs against 494 crates. ✅ All prdocs are valid. ``` Note that not all old prdocs pass the check since crates have been renamed: ```pre $ python3 .github/scripts/check-prdoc.py Cargo.toml prdoc/**/*.prdoc 🔎 Reading workspace polkadot-sdk/Cargo.toml. 📦 Checking 186 prdocs against 494 crates. ❌ Some prdocs are invalid. 💥 prdoc/1.4.0/pr_1926.prdoc lists invalid crate: node-cli 💥 prdoc/1.4.0/pr_2086.prdoc lists invalid crate: xcm-executor 💥 prdoc/1.4.0/pr_2107.prdoc lists invalid crate: xcm 💥 prdoc/1.6.0/pr_2684.prdoc lists invalid crate: xcm-builder ``` --------- Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
68 lines
2.7 KiB
YAML
68 lines
2.7 KiB
YAML
name: Check PRdoc
|
|
|
|
on:
|
|
pull_request:
|
|
types: [labeled, opened, synchronize, unlabeled]
|
|
merge_group:
|
|
|
|
env:
|
|
IMAGE: docker.io/paritytech/prdoc:v0.0.7
|
|
API_BASE: https://api.github.com/repos
|
|
REPO: ${{ github.repository }}
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
GITHUB_PR: ${{ github.event.pull_request.number }}
|
|
ENGINE: docker
|
|
PRDOC_DOC: https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/prdoc.md
|
|
|
|
jobs:
|
|
check-prdoc:
|
|
runs-on: ubuntu-latest
|
|
if: github.event.pull_request.number != ''
|
|
steps:
|
|
- name: Checkout repo
|
|
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 #v4.1.1
|
|
# we cannot show the version in this step (ie before checking out the repo)
|
|
# due to https://github.com/paritytech/prdoc/issues/15
|
|
- name: Check if PRdoc is required
|
|
id: get-labels
|
|
run: |
|
|
echo "Pulling $IMAGE"
|
|
$ENGINE pull $IMAGE
|
|
|
|
# Fetch the labels for the PR under test
|
|
echo "Fetch the labels for $API_BASE/${REPO}/pulls/${GITHUB_PR}"
|
|
labels=$( curl -H "Authorization: token ${GITHUB_TOKEN}" -s "$API_BASE/${REPO}/pulls/${GITHUB_PR}" | jq '.labels | .[] | .name' | tr "\n" ",")
|
|
echo "Labels: ${labels}"
|
|
echo "labels=${labels}" >> "$GITHUB_OUTPUT"
|
|
|
|
echo "Checking PRdoc version"
|
|
$ENGINE run --rm -v $PWD:/repo $IMAGE --version
|
|
|
|
- name: Early exit if PR is silent
|
|
if: ${{ contains(steps.get-labels.outputs.labels, 'R0') }}
|
|
run: |
|
|
hits=$(find prdoc -name "pr_$GITHUB_PR*.prdoc" | wc -l)
|
|
if (( hits > 0 )); then
|
|
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"
|
|
else
|
|
echo "PR detected as silent, no PRDoc found, exiting..."
|
|
fi
|
|
echo "If you want to add a PRDoc, please refer to $PRDOC_DOC"
|
|
exit 0
|
|
|
|
- name: PRdoc check for PR#${{ github.event.pull_request.number }}
|
|
if: ${{ !contains(steps.get-labels.outputs.labels, 'R0') }}
|
|
run: |
|
|
echo "Checking for PR#${GITHUB_PR}"
|
|
echo "You can find more information about PRDoc at $PRDOC_DOC"
|
|
$ENGINE run --rm -v $PWD:/repo -e RUST_LOG=info $IMAGE check -n ${GITHUB_PR}
|
|
|
|
- name: Validate prdoc for PR#${{ github.event.pull_request.number }}
|
|
if: ${{ !contains(steps.get-labels.outputs.labels, 'R0') }}
|
|
run: |
|
|
echo "Validating PR#${GITHUB_PR}"
|
|
python3 --version
|
|
python3 -m pip install cargo-workspace==1.2.1
|
|
python3 .github/scripts/check-prdoc.py Cargo.toml prdoc/pr_${GITHUB_PR}.prdoc
|