Changelogs local generation (#1411)

This PR introduces a script and some templates to use the prdoc involved
in a release and build:
- the changelog
- a simple draft of audience documentation

Since the prdoc presence was enforced in the middle of the version
1.5.0, not all PRs did come with a `prdoc` file.
This PR creates all the missing `prdoc` files with some minimum content
allowing to properly generate the changelog.
The generated content is **not** suitable for the audience
documentation.

The audience documentation will be possible with the next version, when
all PR come with a proper `prdoc`.

## Assumptions

- the prdoc files for release `vX.Y.Z` have been moved under
`prdoc/X.Y.Z`
- the changelog requires for now for the prdoc files to contain author +
topic. Thos fields are optional.

The build script can  be called as:
```
VERSION=X.Y.Z ./scripts/release/build-changelogs.sh
```

Related:
-  #1408

---------

Co-authored-by: EgorPopelyaev <[email protected]>

cumulus/parachains/runtimes/assets/asset-hub-rococo/src/lib.rs

@@ -112,7 +112,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: create_runtime_str!("statemine"),
 	impl_name: create_runtime_str!("statemine"),
 	authoring_version: 1,
-	spec_version: 1_004_000,
+	spec_version: 1_005_000,
 	impl_version: 0,
 	apis: RUNTIME_API_VERSIONS,
 	transaction_version: 13,
@@ -125,7 +125,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: create_runtime_str!("statemine"),
 	impl_name: create_runtime_str!("statemine"),
 	authoring_version: 1,
-	spec_version: 1_004_000,
+	spec_version: 1_005_000,
 	impl_version: 0,
 	apis: RUNTIME_API_VERSIONS,
 	transaction_version: 13,

cumulus/parachains/runtimes/assets/asset-hub-westend/src/lib.rs

@@ -109,7 +109,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: create_runtime_str!("westmint"),
 	impl_name: create_runtime_str!("westmint"),
 	authoring_version: 1,
-	spec_version: 1_004_000,
+	spec_version: 1_005_000,
 	impl_version: 0,
 	apis: RUNTIME_API_VERSIONS,
 	transaction_version: 13,

cumulus/parachains/runtimes/bridge-hubs/bridge-hub-rococo/src/lib.rs

@@ -171,7 +171,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: create_runtime_str!("bridge-hub-rococo"),
 	impl_name: create_runtime_str!("bridge-hub-rococo"),
 	authoring_version: 1,
-	spec_version: 1_004_000,
+	spec_version: 1_005_000,
 	impl_version: 0,
 	apis: RUNTIME_API_VERSIONS,
 	transaction_version: 3,

cumulus/parachains/runtimes/bridge-hubs/bridge-hub-westend/src/lib.rs

@@ -172,7 +172,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: create_runtime_str!("bridge-hub-westend"),
 	impl_name: create_runtime_str!("bridge-hub-westend"),
 	authoring_version: 1,
-	spec_version: 1_004_000,
+	spec_version: 1_005_000,
 	impl_version: 0,
 	apis: RUNTIME_API_VERSIONS,
 	transaction_version: 3,

cumulus/parachains/runtimes/collectives/collectives-westend/src/lib.rs

@@ -114,7 +114,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: create_runtime_str!("collectives-westend"),
 	impl_name: create_runtime_str!("collectives-westend"),
 	authoring_version: 1,
-	spec_version: 1_004_000,
+	spec_version: 1_005_000,
 	impl_version: 0,
 	apis: RUNTIME_API_VERSIONS,
 	transaction_version: 5,

cumulus/parachains/runtimes/contracts/contracts-rococo/src/lib.rs

@@ -133,7 +133,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: create_runtime_str!("contracts-rococo"),
 	impl_name: create_runtime_str!("contracts-rococo"),
 	authoring_version: 1,
-	spec_version: 1_004_000,
+	spec_version: 1_005_000,
 	impl_version: 0,
 	apis: RUNTIME_API_VERSIONS,
 	transaction_version: 6,

cumulus/parachains/runtimes/glutton/glutton-westend/src/lib.rs

@@ -99,7 +99,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: create_runtime_str!("glutton-westend"),
 	impl_name: create_runtime_str!("glutton-westend"),
 	authoring_version: 1,
-	spec_version: 1_004_000,
+	spec_version: 1_005_000,
 	impl_version: 0,
 	apis: RUNTIME_API_VERSIONS,
 	transaction_version: 1,

cumulus/parachains/runtimes/testing/rococo-parachain/src/lib.rs

@@ -106,7 +106,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: create_runtime_str!("test-parachain"),
 	impl_name: create_runtime_str!("test-parachain"),
 	authoring_version: 1,
-	spec_version: 1_004_000,
+	spec_version: 1_005_000,
 	impl_version: 0,
 	apis: RUNTIME_API_VERSIONS,
 	transaction_version: 6,

cumulus/polkadot-parachain/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "polkadot-parachain-bin"
-version = "1.1.0"
+version = "1.5.0"
 authors.workspace = true
 build = "build.rs"
 edition.workspace = true

polkadot/Cargo.toml

@@ -18,7 +18,7 @@ rust-version = "1.64.0"
 readme = "README.md"
 authors.workspace = true
 edition.workspace = true
-version = "1.1.0"
+version = "1.5.0"
 default-run = "polkadot"
 
 [dependencies]

polkadot/node/primitives/src/lib.rs

@@ -58,7 +58,7 @@ pub use disputes::{
 /// relatively rare.
 ///
 /// The associated worker binaries should use the same version as the node that spawns them.
-pub const NODE_VERSION: &'static str = "1.1.0";
+pub const NODE_VERSION: &'static str = "1.5.0";
 
 // For a 16-ary Merkle Prefix Trie, we can expect at most 16 32-byte hashes per node
 // plus some overhead:

polkadot/runtime/rococo/src/lib.rs

@@ -149,7 +149,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: create_runtime_str!("rococo"),
 	impl_name: create_runtime_str!("parity-rococo-v2.0"),
 	authoring_version: 0,
-	spec_version: 1_004_000,
+	spec_version: 1_005_000,
 	impl_version: 0,
 	apis: RUNTIME_API_VERSIONS,
 	transaction_version: 22,

polkadot/runtime/westend/src/lib.rs

@@ -145,7 +145,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: create_runtime_str!("westend"),
 	impl_name: create_runtime_str!("parity-westend"),
 	authoring_version: 2,
-	spec_version: 1_004_000,
+	spec_version: 1_005_000,
 	impl_version: 0,
 	apis: RUNTIME_API_VERSIONS,
 	transaction_version: 22,

prdoc/1.3.0/readme.md

@@ -0,0 +1,2 @@
+Version 1.3.0 does not support `prddoc` yet.
+Some prdoc files are provided but the list is NOT complete.

prdoc/1.4.0/readme.md

@@ -0,0 +1,2 @@
+Version 1.4.0 does not support `prddoc` yet.
+Some prdoc files are provided but the list is NOT complete.

prdoc/1.5.0/pr_1370_special.prdoc

@@ -0,0 +1,9 @@
+title: Rework the event system of `sc-network`
+author: altonen
+topic: Node
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/pr_1408_prodc-introduction.prdoc → prdoc/1.5.0/pr_1408_prodc-introduction.prdoc

@@ -1,6 +1,9 @@
 # This PR does not need a prdoc but it is provided in order to test
 title: PRdoc check
 
+author: chevdor
+topic: documentation
+
 doc:
   - audience: Node Dev
     description: |

prdoc/1.5.0/pr_1497_special.prdoc

@@ -0,0 +1,9 @@
+title: Update tick collator for async backing
+author: Sophia-Gold
+topic: Tests
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_1918_special.prdoc

@@ -0,0 +1,9 @@
+title: Preserve artifact cache unless stale
+author: eagr
+topic: Node
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/pr_1946_prdoc_new_schema.prdoc → prdoc/1.5.0/pr_1946_prdoc_new_schema.prdoc

@@ -3,6 +3,9 @@
 
 title: New PRDoc Schema
 
+author: chevdor
+topic: documentation
+
 doc:
   - audience: Node Dev
     description:  &desc |

prdoc/1.5.0/pr_1985_special.prdoc

@@ -0,0 +1,9 @@
+title: Enable parallel key scraping
+author: eagr
+topic: Node
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2001_special.prdoc

@@ -0,0 +1,9 @@
+title: "cumulus-consensus-common: block import: `delayed_best_block` flag added"
+author: michalkucharczyk
+topic: Node
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2058_special.prdoc

@@ -0,0 +1,9 @@
+title: "PVF: Add test instructions"
+author: mrcnski
+topic: Node
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/pr_2142.prdoc → prdoc/1.5.0/pr_2142.prdoc

@@ -1,5 +1,8 @@
 title: Cleanup XCMP `QueueConfigData`
 
+author: serban300
+topic: runtime
+
 doc:
   - audience: Runtime Dev
     description: Removes obsolete fields from the `QueueConfigData` structure. For the remaining fields, if they use the old defaults, we replace them with the new defaults.

prdoc/1.5.0/pr_2167_special.prdoc

@@ -0,0 +1,9 @@
+title: "add pallet nomination-pools versioned migration to kitchensink"
+author: brunopgalvao
+topic: Tests
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2174_special.prdoc

@@ -0,0 +1,9 @@
+title: "chain-spec-builder: cleanup"
+author: michalkucharczyk
+topic: Node
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2182_special.prdoc

@@ -0,0 +1,9 @@
+title: "remove retry from backers on failed candidate validation"
+author: Jpserrat
+topic: Node
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2184_special.prdoc

@@ -0,0 +1,9 @@
+title: Zombienet tests - disputes on finalized blocks
+author: Overkillus
+topic: Tests
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2221_special.prdoc

@@ -0,0 +1,9 @@
+title: "PVF worker: switch on seccomp networking restrictions"
+author: mrcnski
+topic: Node
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2250_special.prdoc

@@ -0,0 +1,9 @@
+title: "crypto: `lazy_static` removed, light parser for address URI added"
+author: michalkucharczyk
+topic: Node
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/pr_2253.prdoc → prdoc/1.5.0/pr_2253.prdoc

@@ -3,6 +3,9 @@
 
 title: Different builder pattern constructors for XCM
 
+author: franciscoaguirre
+topic: runtime
+
 doc:
   - audience: Runtime Dev
     description: |

prdoc/1.5.0/pr_2265_special.prdoc

@@ -0,0 +1,9 @@
+title: Remove im-online pallet from Rococo and Westend
+author: s0me0ne-unkn0wn
+topic: Pallets
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2300_special.prdoc

@@ -0,0 +1,9 @@
+title: '[testnet] Remove Wococo stuff from BridgeHubRococo/AssetHubRococo'
+author: bkontur 
+topic: Bridges
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2351_special.prdoc

@@ -0,0 +1,9 @@
+title: "frame-system: Add last_runtime_upgrade_spec_version"
+author: bkchr
+topic: Frame
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2354_special.prdoc

@@ -0,0 +1,9 @@
+title: "Fix Typo: `PalletXcmExtrinsicsBenchmark`"
+author: joepetrowski
+topic: Benchmarks
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2361_special.prdoc

@@ -0,0 +1,9 @@
+title: "[ci] Enable zombienet jobs in PRs"
+author: alvicsam
+topic: Tests
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2368_special.prdoc

@@ -0,0 +1,9 @@
+title: "implementers-guide: update github link"
+author: ordian
+topic: Documentation
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2369_special.prdoc

@@ -0,0 +1,9 @@
+title: "[NPoS] Check if staker is exposed in paged exposure storage entries"
+author: Ank4n
+topic: Pallets
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2377_special.prdoc

@@ -0,0 +1,9 @@
+title: "fix typo"
+author: cuteolaf
+topic: Documentation
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []

prdoc/1.5.0/pr_2378_special.prdoc

@@ -0,0 +1,9 @@
+title: "Beefy: small fixes"
+author: serban300
+topic: Bridges
+
+doc:
+  - audience: Runtime Dev
+    description: n/a
+
+crates: []