[prdoc] Validate crate names

.github/scripts/check-prdoc.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python3
+
+'''
+Ensure that the prdoc files are valid.
+
+# Example
+
+```sh
+python3 -m pip install cargo-workspace
+python3 .github/scripts/check-prdoc.py Cargo.toml prdoc/*.prdoc
+```
+
+Produces example output:
+```pre
+🔎 Reading workspace polkadot-sdk/Cargo.toml
+📦 Checking 32 prdocs against 493 crates.
+✅ All prdocs are valid
+```
+'''
+
+import os
+import yaml
+import argparse
+import cargo_workspace
+
+def check_prdoc_crate_names(root, paths):
+	'''
+	Check that all crates of the `crates` section of each prdoc is present in the workspace.
+	'''
+
+	print(f'🔎 Reading workspace {root}.')
+	workspace = cargo_workspace.Workspace.from_path(root)
+	crate_names = [crate.name for crate in workspace.crates]
+
+	print(f'📦 Checking {len(paths)} prdocs against {len(crate_names)} crates.')
+	faulty = {}
+
+	for path in paths:
+		with open(path, 'r') as f:
+			prdoc = yaml.safe_load(f)
+
+		for crate in prdoc.get('crates', []):
+			crate = crate['name']
+			if crate in crate_names:
+				continue
+
+			faulty.setdefault(path, []).append(crate)
+
+	if len(faulty) == 0:
+		print('✅ All prdocs are valid.')
+	else:
+		print('❌ Some prdocs are invalid.')
+		for path, crates in faulty.items():
+			print(f'💥 {path} lists invalid crate: {", ".join(crates)}')
+		exit(1)
+
+def parse_args():
+	parser = argparse.ArgumentParser(description='Check prdoc files')
+	parser.add_argument('root', help='The cargo workspace manifest', metavar='root', type=str, nargs=1)
+	parser.add_argument('prdoc', help='The prdoc files', metavar='prdoc', type=str, nargs='*')
+	args = parser.parse_args()
+
+	if len(args.prdoc) == 0:
+		print('❌ Need at least one prdoc file as argument.')
+		exit(1)
+
+	return { 'root': os.path.abspath(args.root[0]), 'prdocs': args.prdoc }
+
+if __name__ == '__main__':
+	args = parse_args()
+	check_prdoc_crate_names(args['root'], args['prdocs'])

.github/workflows/check-prdoc.yml

@@ -57,3 +57,11 @@ jobs:
           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

prdoc/1.4.0/pr_1246.prdoc

@@ -11,7 +11,7 @@ migrations:
       description: "Messages from the DMP dispatch queue will be moved over to the MQ pallet via `on_initialize`. This happens over multiple blocks and emits a `Completed` event at the end. The pallet can be un-deployed and deleted afterwards. Note that the migration reverses the order of messages, which should be acceptable as a one-off."
 
 crates:
-  - name: cumulus_pallet_xcmp_queue
+  - name: cumulus-pallet-xcmp-queue
     note: Pallet config must be altered according to the MR description.
 
 host_functions: []

prdoc/1.6.0/pr_2689.prdoc

@@ -1,7 +1,7 @@
 # Schema: Parity PR Documentation Schema (prdoc)
 # See doc at https://github.com/paritytech/prdoc
 
-title: BEEFY: Support compatibility with Warp Sync - Allow Warp Sync for Validators
+title: "BEEFY: Support compatibility with Warp Sync - Allow Warp Sync for Validators"
 
 doc:
   - audience: Node Operator

prdoc/1.6.0/pr_2771.prdoc

@@ -6,4 +6,4 @@ doc:
       Enable better req-response protocol versioning, by allowing for fallback requests on different protocols.
 
 crates:
-  - name: sc_network
+  - name: sc-network

prdoc/pr_3412.prdoc

@@ -13,5 +13,5 @@ doc:
 
 crates:
   - name: pallet-babe
-  - name: pallet-aura-ext
+  - name: cumulus-pallet-aura-ext
   - name: pallet-session