pezkuwichain
ee389beb8c
- Add 72 rebrand workflow files (polkadot→pezkuwi, substrate→bizinikiwi, cumulus→pezcumulus) - Add GitHub actions, issue templates, and configs - Removed unnecessary workflows (fork-sync, gitspiegel, upstream-tracker, sync-templates, backport) - Renamed zombienet test files to match new naming convention
72 lines
1.8 KiB
Python
72 lines
1.8 KiB
Python
#!/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 pezkuwi-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'])
|