Skip to content
Snippets Groups Projects
  • Oliver Tale-Yazdi's avatar
    [prdoc] Validate crate names (#3467) · 4080632e
    Oliver Tale-Yazdi authored
    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
    
    :mag_right: Reading workspace polkadot-sdk/Cargo.toml.
    :package: Checking 36 prdocs against 494 crates.
    :white_check_mark: 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
    
    :mag_right: Reading workspace polkadot-sdk/Cargo.toml.
    :package: Checking 186 prdocs against 494 crates.
    :x: Some prdocs are invalid.
    :boom: prdoc/1.4.0/pr_1926.prdoc lists invalid crate: node-cli
    :boom: prdoc/1.4.0/pr_2086.prdoc lists invalid crate: xcm-executor
    :boom: prdoc/1.4.0/pr_2107.prdoc lists invalid crate: xcm
    :boom:
    
     prdoc/1.6.0/pr_2684.prdoc lists invalid crate: xcm-builder
    
    ```
    
    ---------
    
    Signed-off-by: default avatarOliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
    Unverified
    4080632e
Code owners
Assign users and groups as approvers for specific file changes. Learn more.