4080632ee0
[prdoc] Validate crate names ( #3467 )
...
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 >
2024-02-26 17:23:37 +00:00
64050cf347
prdoc: Print errors on CI ( #3459 )
...
By passing `RUST_LOG=info` to the check command, we will be able to see
the exact problem with a given prdoc.
Before:
```
PR #3243 -> ERR
```
After:
```
[2024-02-23T12:53:55Z INFO prdoclib::commands::check] Checking directory prdoc
[2024-02-23T12:53:55Z INFO prdoclib::commands::check] Using schema: /Users/sebastian/work/repos/polkadot-sdk/prdoc/schema_user.json
[2024-02-23T12:53:55Z WARN prdoclib::schema] validation_result: false
[2024-02-23T12:53:55Z WARN prdoclib::schema] validation_result_strict: false
[2024-02-23T12:53:55Z WARN prdoclib::schema] errors: [
Required {
path: "/title",
},
]
[2024-02-23T12:53:55Z WARN prdoclib::schema] missing: []
[2024-02-23T12:53:55Z ERROR prdoclib::commands::check] Loading the schema failed:
[2024-02-23T12:53:55Z ERROR prdoclib::commands::check] ValidationErrors(ValidationState { errors: [Required { path: "/title" }], missing: [], replacement: None, evaluated: {"/doc/0/description", "/crates/0/name", "/doc/0", "/crates", "/crates/0", "", "/doc", "/doc/0/audience"} })
PR #3243 -> ERR
```
2024-02-23 14:04:10 +01:00
c3489aaf2f
[ci] Don't run prdoc and lables GHA on master ( #3257 )
...
PR adds condition to ignore master branch for prdoc and labels GHA.
This option doesn't work because all PRs are for master thus the actions
won't start:
```yml
on:
pull_request:
branches-ignore:
- master
```
This option doesn't work because actions don't see the PR number and
[break](https://github.com/paritytech/polkadot-sdk/actions/runs/7827272667/job/21354764953 ):
```yml
on:
push:
branches-ignore:
- master
```
cc https://github.com/paritytech/ci_cd/issues/940
cc https://github.com/paritytech/polkadot-sdk/issues/3240
2024-02-12 10:30:46 +00:00
a310df263d
Move developer-hub to polkadot-sdk-docs ( #2598 )
...
This PR is a continuation of
https://github.com/paritytech/polkadot-sdk/pull/2102 and part of an
initiative started here https://hackmd.io/@romanp/rJ318ZCEp
What has been done:
- The content under `docs/*` (with the exception of `docs/mermaid`) has
been moved to `docs/contributor/`
- Developer Hub has been renamed to Polkadot SDK Docs, and the crate has
been renamed from `developer-hub` to `polkadot-sdk-docs`
- The content under `developer-hub/*` has been moved to `docs/sdk`
---
Original PR https://github.com/paritytech/polkadot-sdk/pull/2565 , it has
been close due to too many rebase conflicts
---------
Co-authored-by: Serban Iorga <serban@parity.io >
Co-authored-by: Chevdor <chevdor@users.noreply.github.com >
Co-authored-by: Egor_P <egor@parity.io >
Co-authored-by: Bastian Köcher <git@kchr.de >
2023-12-05 10:23:24 +01:00
756a12d571
PRDoc new schema ( #1946 )
...
## Overview
This PR brings in the new version of prdoc v0.0.6 and allows:
- local schema
- local config
- local template
It also fixes the existing prdoc files to match the new schema.
## todo
- [x] add a brief doc/tldr to help contributors get started
- [x] test CI
- [x] finalize schema
- [x] publish the next `prdoc` cli version (v0.0.7 or above)
---------
Co-authored-by: Egor_P <egor@parity.io >
Co-authored-by: Bastian Köcher <git@kchr.de >
2023-12-04 14:25:57 +00:00
5b0622bc4d
[CI] Prepare CI for Merge Queues ( #2308 )
...
PR prepares CI to the GitHub Merge Queues. All github actions that were
running in PR adjusted so they can run in the merge queues. Zombienet
jobs will do nothing during PRs but they will run during merge queues.
Jobs that will be skipped during PR:
- all zombienet jobs
- all publish docker jobs
Jobs that will be skipped during merge queue:
- check-labels
- check-prdoc
- pr-custom-review
- review trigger
cc https://github.com/paritytech/ci_cd/issues/862
2023-11-15 14:28:32 +01:00
961a8fd77e
Pin PRDoc image to v0.0.5 until we are ready for v0.0.6 ( #1947 )
...
This PR prevents failures until #1946 is merged.
2023-10-19 19:26:09 +02:00
e34aa4b78e
Bump actions/checkout from 4.1.0 to 4.1.1 ( #1925 )
...
Bumps [actions/checkout](https://github.com/actions/checkout ) from 4.1.0 to 4.1.1.
2023-10-18 09:39:57 +02:00
b18fb35e0d
Bump actions/checkout from 4.0.0 to 4.1.0 ( #1688 )
...
Bumps [actions/checkout](https://github.com/actions/checkout ) from 4.0.0
to 4.1.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/actions/checkout/releases ">actions/checkout's
releases</a>.</em></p>
<blockquote>
<h2>v4.1.0</h2>
<h2>What's Changed</h2>
<ul>
<li>Update README.md for V4 by <a
href="https://github.com/sivapalan "><code>@sivapalan</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/1452 ">actions/checkout#1452</a></li>
<li>Add support for partial checkout filters by <a
href="https://github.com/finleygn "><code>@finleygn</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/1396 ">actions/checkout#1396</a></li>
<li>Prepare 4.1.0 release by <a
href="https://github.com/cory-miller "><code>@cory-miller</code></a> in
<a
href="https://redirect.github.com/actions/checkout/pull/1496 ">actions/checkout#1496</a></li>
</ul>
<h2>New Contributors</h2>
<ul>
<li><a href="https://github.com/sivapalan "><code>@sivapalan</code></a>
made their first contribution in <a
href="https://redirect.github.com/actions/checkout/pull/1452 ">actions/checkout#1452</a></li>
<li><a href="https://github.com/finleygn "><code>@finleygn</code></a>
made their first contribution in <a
href="https://redirect.github.com/actions/checkout/pull/1396 ">actions/checkout#1396</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/actions/checkout/compare/v4.0.0...v4.1.0 ">https://github.com/actions/checkout/compare/v4.0.0...v4.1.0 </a></p>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/actions/checkout/blob/main/CHANGELOG.md ">actions/checkout's
changelog</a>.</em></p>
<blockquote>
<h1>Changelog</h1>
<h2>v4.1.0</h2>
<ul>
<li><a href="https://redirect.github.com/actions/checkout/pull/1396 ">Add
support for partial checkout filters</a></li>
</ul>
<h2>v4.0.0</h2>
<ul>
<li><a
href="https://redirect.github.com/actions/checkout/pull/1067 ">Support
fetching without the --progress option</a></li>
<li><a
href="https://redirect.github.com/actions/checkout/pull/1436 ">Update to
node20</a></li>
</ul>
<h2>v3.6.0</h2>
<ul>
<li><a
href="https://redirect.github.com/actions/checkout/pull/1377 ">Fix: Mark
test scripts with Bash'isms to be run via Bash</a></li>
<li><a href="https://redirect.github.com/actions/checkout/pull/579 ">Add
option to fetch tags even if fetch-depth > 0</a></li>
</ul>
<h2>v3.5.3</h2>
<ul>
<li><a
href="https://redirect.github.com/actions/checkout/pull/1196 ">Fix:
Checkout fail in self-hosted runners when faulty submodule are
checked-in</a></li>
<li><a href="https://redirect.github.com/actions/checkout/pull/1287 ">Fix
typos found by codespell</a></li>
<li><a href="https://redirect.github.com/actions/checkout/pull/1369 ">Add
support for sparse checkouts</a></li>
</ul>
<h2>v3.5.2</h2>
<ul>
<li><a href="https://redirect.github.com/actions/checkout/pull/1289 ">Fix
api endpoint for GHES</a></li>
</ul>
<h2>v3.5.1</h2>
<ul>
<li><a href="https://redirect.github.com/actions/checkout/pull/1246 ">Fix
slow checkout on Windows</a></li>
</ul>
<h2>v3.5.0</h2>
<ul>
<li><a href="https://redirect.github.com/actions/checkout/pull/1237 ">Add
new public key for known_hosts</a></li>
</ul>
<h2>v3.4.0</h2>
<ul>
<li><a
href="https://redirect.github.com/actions/checkout/pull/1209 ">Upgrade
codeql actions to v2</a></li>
<li><a
href="https://redirect.github.com/actions/checkout/pull/1210 ">Upgrade
dependencies</a></li>
<li><a
href="https://redirect.github.com/actions/checkout/pull/1225 ">Upgrade
<code>@actions/io</code></a></li>
</ul>
<h2>v3.3.0</h2>
<ul>
<li><a
href="https://redirect.github.com/actions/checkout/pull/1045 ">Implement
branch list using callbacks from exec function</a></li>
<li><a href="https://redirect.github.com/actions/checkout/pull/1050 ">Add
in explicit reference to private checkout options</a></li>
<li>[Fix comment typos (that got added in <a
href="https://redirect.github.com/actions/checkout/issues/770 ">#770</a>)](<a
href="https://redirect.github.com/actions/checkout/pull/1057 ">actions/checkout#1057</a>)</li>
</ul>
<h2>v3.2.0</h2>
<ul>
<li><a href="https://redirect.github.com/actions/checkout/pull/942 ">Add
GitHub Action to perform release</a></li>
<li><a href="https://redirect.github.com/actions/checkout/pull/967 ">Fix
status badge</a></li>
<li><a
href="https://redirect.github.com/actions/checkout/pull/1002 ">Replace
datadog/squid with ubuntu/squid Docker image</a></li>
<li><a href="https://redirect.github.com/actions/checkout/pull/964 ">Wrap
pipeline commands for submoduleForeach in quotes</a></li>
<li><a
href="https://redirect.github.com/actions/checkout/pull/1029 ">Update
<code>@actions/io</code> to 1.1.2</a></li>
<li><a
href="https://redirect.github.com/actions/checkout/pull/1039 ">Upgrading
version to 3.2.0</a></li>
</ul>
<h2>v3.1.0</h2>
<ul>
<li><a href="https://redirect.github.com/actions/checkout/pull/939 ">Use
<code>@actions/core</code> <code>saveState</code> and
<code>getState</code></a></li>
<li><a href="https://redirect.github.com/actions/checkout/pull/922 ">Add
<code>github-server-url</code> input</a></li>
</ul>
<h2>v3.0.2</h2>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/actions/checkout/commit/8ade135a41bc03ea155e62e844d188df1ea18608 "><code>8ade135</code></a>
Prepare 4.1.0 release (<a
href="https://redirect.github.com/actions/checkout/issues/1496 ">#1496</a>)</li>
<li><a
href="https://github.com/actions/checkout/commit/c533a0a4cfc4962971818edcfac47a2899e69799 "><code>c533a0a</code></a>
Add support for partial checkout filters (<a
href="https://redirect.github.com/actions/checkout/issues/1396 ">#1396</a>)</li>
<li><a
href="https://github.com/actions/checkout/commit/72f2cec99f417b1a1c5e2e88945068983b7965f9 "><code>72f2cec</code></a>
Update README.md for V4 (<a
href="https://redirect.github.com/actions/checkout/issues/1452 ">#1452</a>)</li>
<li>See full diff in <a
href="https://github.com/actions/checkout/compare/3df4ab11eba7bda6032a0b82a6bb43b11571feac...8ade135a41bc03ea155e62e844d188df1ea18608 ">compare
view</a></li>
</ul>
</details>
<br />
[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores )
Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
<details>
<summary>Dependabot commands and options</summary>
<br />
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
</details>
Signed-off-by: dependabot[bot] <support@github.com >
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-09-25 17:53:16 +03:00
c5f7abe27f
Switch prdoc to the latest image ( #1460 )
2023-09-08 14:45:54 +03:00
a36d409e67
[ci] change image for prdoc gha ( #1452 )
2023-09-07 18:53:31 +02:00
0090152386
Prevent a fail prdoc check to block ( #1433 )
2023-09-06 20:34:41 +03:00
50de035f6d
Fix PRdoc check ( #1419 )
2023-09-06 13:58:53 +02:00
eaf380aaf5
Add PRdoc check ( #1408 )
...
* Add test prdoc
* Prepare for the check
* Escape PR number
* Fix conditional step
* Add checkout and actual check
* Cleanup
* Minor fixes
* Add doumentation
* Add more doc
2023-09-06 11:25:47 +03:00
Oliver Tale-Yazdi