Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[prdoc] Validate crate names #3467

Merged
merged 10 commits into from
Feb 26, 2024
Merged

[prdoc] Validate crate names #3467

merged 10 commits into from
Feb 26, 2024

Conversation

ggwpez
Copy link
Member

@ggwpez ggwpez commented Feb 23, 2024 •
edited
Loading

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 #3441.

Example output:

$ 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:

$ 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

@ggwpez
[prdoc] Validate crate names
4c122e0 
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
@ggwpez
Fixup old prdocs
f1da4ce 
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
@ggwpez ggwpez requested review from a team as code owners February 23, 2024 17:06
@ggwpez ggwpez changed the title Oty prdoc crate [prdoc] Validate crate names Feb 23, 2024
@ggwpez ggwpez self-assigned this Feb 23, 2024
@ggwpez
Update version
903c210 
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
@ggwpez
Update again
8f4aed3 
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
@ggwpez ggwpez added R0-silent Changes should not be mentioned in any release notes and removed R0-silent Changes should not be mentioned in any release notes labels Feb 24, 2024
@ggwpez
Test with bad Prdoc
0222ba1 
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
@ggwpez
Downgrate
066a286 
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
bkchr
bkchr approved these changes Feb 24, 2024
View reviewed changes
Copy link
Member

@bkchr bkchr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@ggwpez ggwpez added R0-silent Changes should not be mentioned in any release notes and removed R0-silent Changes should not be mentioned in any release notes labels Feb 26, 2024
@ggwpez
Debug Python
d593f09 
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
@ggwpez
Debug python
14c1326 
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
@ggwpez
Revert "Test with bad Prdoc"
61b1baf 
This reverts commit 0222ba1.
@ggwpez ggwpez added the R0-silent Changes should not be mentioned in any release notes label Feb 26, 2024
@ggwpez ggwpez added this pull request to the merge queue Feb 26, 2024
@ggwpez ggwpez removed this pull request from the merge queue due to a manual request Feb 26, 2024
@ggwpez
Use prod pypi instance
c1215f6 
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
@ggwpez ggwpez added this pull request to the merge queue Feb 26, 2024
Merged via the queue into master with commit 4080632 Feb 26, 2024
127 of 129 checks passed
@ggwpez ggwpez deleted the oty-prdoc-crate branch February 26, 2024 19:33
ordian added a commit that referenced this pull request Feb 28, 2024
@ordian
Merge remote-tracking branch 'origin/master' into ao-collator-parent-…
8b70d0f 
…head-data

* origin/master: (51 commits)
  Runtime Upgrade ref docs and Single Block Migration example pallet  (#1554)
  Collator overseer builder unification (#3335)
  Introduce storage attr macro `#[disable_try_decode_storage]` and set it on `System::Events` and `ParachainSystem::HostConfiguration` (#3454)
  Add Polkadotters bootnoders per IBP application (#3423)
  Add documentation around FRAME Origin (#3362)
  Bridge zombienet tests: Check amount received at destination (#3490)
  Snowbridge benchmark tests fix (#3424)
  fix(zombienet): increase timeout in download artifacts (#3376)
  Cleanup String::from_utf8 (#3446)
  [prdoc] Validate crate names (#3467)
  Limit max execution time for `test-linux-stable` CI jobs (#3483)
  Introduce Notification block pinning limit (#2935)
  frame-support: Improve error reporting when having too many pallets (#3478)
  add Encointer as trusted teleporter for Westend (#3411)
  [pallet-xcm] Adjust benchmarks (teleport_assets/reserve_transfer_assets) not relying on ED (#3464)
  Add more debug logs to understand if statement-distribution misbehaving (#3419)
  Remove redundant parachains assigner pallet. (#3457)
  Use generic hash for runtime wasm in resolve_state_version_from_wasm (#3447)
  Runtime: allow backing multiple candidates of same parachain on different cores  (#3231)
  Bridge zombienet tests: move all "framework" files under one folder (#3462)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bkchr bkchr bkchr approved these changes

@alvicsam alvicsam alvicsam approved these changes

@Morganamilo Morganamilo Awaiting requested review from Morganamilo

Assignees

@ggwpez ggwpez

Labels
R0-silent Changes should not be mentioned in any release notes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@ggwpez @bkchr @alvicsam