Move migrations to versioned tuples

.config/lychee.toml

@@ -47,4 +47,11 @@ exclude = [
 	"https://w3f.github.io/parachain-implementers-guide/node/index.html",
 	"https://w3f.github.io/parachain-implementers-guide/protocol-chain-selection.html",
 	"https://w3f.github.io/parachain-implementers-guide/runtime/session_info.html",
+
+	# Private or unaccessible repos
+	"https://github.com/paritytech/ci_cd/.*",
+	"https://iohk.io/en/blog/.*",
+
+	# Not checking websockets
+	"wss?://.*"
 ]

.github/workflows/check-migrations-tuples.yml

@@ -0,0 +1,31 @@
+name: Lint Migration Tuples
+
+# This GHA uses https://crates.io/crates/submig to check the namingg and the
+# syntax of the migrations, ensuring they are versioning. `submig` parses the code
+# and checks that all runtimes found comply with the pattern.
+
+on:
+  pull_request:
+    types: [labeled, opened, synchronize, unlabeled]
+
+jobs:
+  check-migrations:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@3cf7f8cc28d1b4e7d01e3783be10a97d55d483c8 # v2.7.1
+        with:
+          cache-on-failure: true
+
+      - name: Install submig
+        run: |
+          cargo install submig
+          submig --version
+
+      - name: Checkout repo
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 #v4.1.1
+
+      - name: Check migrations
+        continue-on-error: false
+        run: |
+          submig list .

bridges/primitives/runtime/src/chain.rs

@@ -92,7 +92,7 @@ impl<ChainCall: Encode> Encode for EncodedOrDecodedCall<ChainCall> {
 /// Minimal Substrate-based chain representation that may be used from no_std environment.
 pub trait Chain: Send + Sync + 'static {
 	/// A type that fulfills the abstract idea of what a Substrate block number is.
-	// Constraits come from the associated Number type of `sp_runtime::traits::Header`
+	// Constrains come from the associated Number type of `sp_runtime::traits::Header`
 	// See here for more info:
 	// https://crates.parity.io/sp_runtime/traits/trait.Header.html#associatedtype.Number
 	//
@@ -113,7 +113,7 @@ pub trait Chain: Send + Sync + 'static {
 		+ MaxEncodedLen;
 
 	/// A type that fulfills the abstract idea of what a Substrate hash is.
-	// Constraits come from the associated Hash type of `sp_runtime::traits::Header`
+	// Constrains come from the associated Hash type of `sp_runtime::traits::Header`
 	// See here for more info:
 	// https://crates.parity.io/sp_runtime/traits/trait.Header.html#associatedtype.Hash
 	type Hash: Parameter
@@ -129,9 +129,9 @@ pub trait Chain: Send + Sync + 'static {
 		+ AsMut<[u8]>
 		+ MaxEncodedLen;
 
-	/// A type that fulfills the abstract idea of what a Substrate hasher (a type
+	/// A type that fulfills the abstract idea of what a Substrate `Hasher`` (a type
 	/// that produces hashes) is.
-	// Constraits come from the associated Hashing type of `sp_runtime::traits::Header`
+	// Constrains come from the associated Hashing type of `sp_runtime::traits::Header`
 	// See here for more info:
 	// https://crates.parity.io/sp_runtime/traits/trait.Header.html#associatedtype.Hashing
 	type Hasher: HashT<Output = Self::Hash>;

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

@@ -944,14 +944,42 @@ pub type SignedExtra = (
 /// Unchecked extrinsic type as expected by this runtime.
 pub type UncheckedExtrinsic =
 	generic::UncheckedExtrinsic<Address, RuntimeCall, Signature, SignedExtra>;
-/// Migrations to apply on runtime upgrade.
+
+/// All migrations that will run on the next runtime upgrade.
+///
+/// This contains the combined migrations of the last 10 releases. It allows to skip runtime
+/// upgrades in case governance decides to do so. THE ORDER IS IMPORTANT.
+#[rustfmt::skip]
 pub type Migrations = (
-	pallet_collator_selection::migration::v1::MigrateToV1<Runtime>,
-	InitStorageVersions,
-	// unreleased
-	cumulus_pallet_xcmp_queue::migration::v4::MigrationToV4<Runtime>,
+	migrations::V1_04_00,
+	migrations::V1_05_00,
+	migrations::Unreleased
 );
 
+/// The runtime migrations per release.
+#[allow(deprecated, missing_docs)]
+pub mod migrations {
+	use super::*;
+
+	pub type V1_04_00 = ();
+
+	pub type V1_05_00 = ();
+
+	/// New migrations should be added here in the `Unreleased` tuple.
+	/// During the release process for release `x.y.z``, the `Unreleased` migrations
+	/// will be moved to a new tuple named `Vx_y_z` and added to the migration
+	/// to execute. The `Unreleased` tuple will then be cleared.
+	/// This allows keeping track of the migrations that have been applied to the
+	/// runtime *per version*.
+	// Do not remove `#[rustfmt::skip]` or the empty tuple, even if it appears
+	// to be *temporarily* not needed. Keep a single migration per line.
+	#[rustfmt::skip]
+	pub type Unreleased = (
+		pallet_collator_selection::migration::v1::MigrateToV1<Runtime>,
+		InitStorageVersions,
+	);
+}
+
 /// Migration to initialize storage versions for pallets added after genesis.
 ///
 /// This is now done automatically (see <https://github.com/paritytech/polkadot-sdk/pull/1297>),
@@ -1004,6 +1032,33 @@ impl frame_support::traits::OnRuntimeUpgrade for InitStorageVersions {
 	}
 }
 
+/// All migrations that will run on the next runtime upgrade.
+///
+/// This contains the combined migrations of the last 10 releases. It allows to skip runtime
+/// upgrades in case governance decides to do so. THE ORDER IS IMPORTANT.
+#[rustfmt::skip]
+pub type Migrations = (
+	migrations::V1_04_00,
+	migrations::V1_05_00,
+	migrations::Unreleased,
+);
+
+/// The runtime migrations per release.
+#[allow(deprecated, missing_docs)]
+pub mod migrations {
+	use super::*;
+
+	pub type V1_04_00 = ();
+
+	pub type V1_05_00 = ();
+
+	pub type Unreleased = (
+		pallet_collator_selection::migration::v1::MigrateToV1<Runtime>,
+		InitStorageVersions,
+		cumulus_pallet_xcmp_queue::migration::v4::MigrationToV4<Runtime>,
+	);
+}
+
 /// Executive: handles dispatch to the various modules.
 pub type Executive = frame_executive::Executive<
 	Runtime,

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

@@ -918,24 +918,47 @@ pub type SignedExtra = (
 pub type UncheckedExtrinsic =
 	generic::UncheckedExtrinsic<Address, RuntimeCall, Signature, SignedExtra>;
 
-/// Migrations to apply on runtime upgrade.
+/// All migrations that will run on the next runtime upgrade.
+///
+/// This contains the combined migrations of the last 10 releases. It allows to skip runtime
+/// upgrades in case governance decides to do so. THE ORDER IS IMPORTANT.
+#[rustfmt::skip]
 pub type Migrations = (
-	// v9420
-	pallet_nfts::migration::v1::MigrateToV1<Runtime>,
-	// unreleased
-	pallet_collator_selection::migration::v1::MigrateToV1<Runtime>,
-	// unreleased
-	migrations::NativeAssetParents0ToParents1Migration<Runtime>,
-	// unreleased
-	pallet_multisig::migrations::v1::MigrateToV1<Runtime>,
-	// unreleased
-	InitStorageVersions,
-	// unreleased
-	DeleteUndecodableStorage,
-	// unreleased
-	cumulus_pallet_xcmp_queue::migration::v4::MigrationToV4<Runtime>,
+	migrations::V0_09_20,
+	migrations::V1_04_00,
+	migrations::V1_05_00,
+	migrations::Unreleased
 );
 
+/// The runtime migrations per release.
+#[allow(deprecated, missing_docs)]
+pub mod migrations {
+	use super::*;
+
+	pub type V0_09_20 = (pallet_nfts::migration::v1::MigrateToV1<Runtime>,);
+
+	pub type V1_04_00 = ();
+
+	pub type V1_05_00 = ();
+
+	/// New migrations should be added here in the `Unreleased` tuple.
+	/// During the release process for release `x.y.z``, the `Unreleased` migrations
+	/// will be moved to a new tuple named `Vx_y_z` and added to the migration
+	/// to execute. The `Unreleased` tuple will then be cleared.
+	/// This allows keeping track of the migrations that have been applied to the
+	/// runtime *per version*.
+	// Do not remove `#[rustfmt::skip]` or the empty tuple, even if it appears
+	// to be *temporarily* not needed. Keep a single migration per line.
+	#[rustfmt::skip]
+	pub type Unreleased = (
+		pallet_collator_selection::migration::v1::MigrateToV1<Runtime>,
+		asset_hub_westend_migrations::NativeAssetParents0ToParents1Migration<Runtime>,
+		pallet_multisig::migrations::v1::MigrateToV1<Runtime>,
+		InitStorageVersions,
+		DeleteUndecodableStorage,
+	);
+}
+
 /// Asset Hub Westend has some undecodable storage, delete it.
 /// See <https://github.com/paritytech/polkadot-sdk/issues/2241> for more info.
 ///
@@ -1005,6 +1028,39 @@ impl frame_support::traits::OnRuntimeUpgrade for DeleteUndecodableStorage {
 	}
 }
 
+/// All migrations that will run on the next runtime upgrade.
+///
+/// This contains the combined migrations of the last 10 releases. It allows to skip runtime
+/// upgrades in case governance decides to do so. THE ORDER IS IMPORTANT.
+#[rustfmt::skip]
+pub type Migrations = (
+	migrations::V0_09_20,
+	migrations::V1_04_00,
+	migrations::V1_05_00,
+	migrations::Unreleased,
+);
+
+/// The runtime migrations per release.
+#[allow(deprecated, missing_docs)]
+pub mod migrations {
+	use super::*;
+
+	pub type V0_09_20 = (pallet_nfts::migration::v1::MigrateToV1<Runtime>,);
+
+	pub type V1_04_00 = ();
+
+	pub type V1_05_00 = ();
+
+	pub type Unreleased = (
+		pallet_collator_selection::migration::v1::MigrateToV1<Runtime>,
+		migrations::NativeAssetParents0ToParents1Migration<Runtime>,
+		pallet_multisig::migrations::v1::MigrateToV1<Runtime>,
+		InitStorageVersions,
+		DeleteUndecodableStorage,
+		cumulus_pallet_xcmp_queue::migration::v4::MigrationToV4<Runtime>,
+	);
+}
+
 /// Migration to initialize storage versions for pallets added after genesis.
 ///
 /// Ideally this would be done automatically (see
@@ -1692,7 +1748,7 @@ cumulus_pallet_parachain_system::register_validate_block! {
 	BlockExecutor = cumulus_pallet_aura_ext::BlockExecutor::<Runtime, Executive>,
 }
 
-pub mod migrations {
+pub mod asset_hub_westend_migrations {
 	use super::*;
 	use frame_support::{
 		pallet_prelude::Get,

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

@@ -113,14 +113,43 @@ pub type SignedExtra = (
 pub type UncheckedExtrinsic =
 	generic::UncheckedExtrinsic<Address, RuntimeCall, Signature, SignedExtra>;
 
-/// Migrations to apply on runtime upgrade.
+/// All migrations that will run on the next runtime upgrade.
+///
+/// This contains the combined migrations of the last 10 releases. It allows to skip runtime
+/// upgrades in case governance decides to do so. THE ORDER IS IMPORTANT.
+#[rustfmt::skip]
 pub type Migrations = (
-	pallet_collator_selection::migration::v1::MigrateToV1<Runtime>,
-	pallet_multisig::migrations::v1::MigrateToV1<Runtime>,
-	InitStorageVersions,
-	cumulus_pallet_xcmp_queue::migration::v4::MigrationToV4<Runtime>,
+	migrations::V1_04_00,
+	migrations::V1_05_00,
+	migrations::Unreleased,
 );
 
+/// The runtime migrations per release.
+#[allow(deprecated, missing_docs)]
+pub mod migrations {
+	use super::*;
+
+	pub type V1_04_00 = ();
+
+	pub type V1_05_00 = ();
+
+	/// New migrations should be added here in the `Unreleased` tuple.
+	/// During the release process for release `x.y.z``, the `Unreleased` migrations
+	/// will be moved to a new tuple named `Vx_y_z` and added to the migration
+	/// to execute. The `Unreleased` tuple will then be cleared.
+	/// This allows keeping track of the migrations that have been applied to the
+	/// runtime *per version*.
+	// Do not remove `#[rustfmt::skip]` or the empty tuple, even if it appears
+	// to be *temporarily* not needed. Keep a single migration per line.
+	#[rustfmt::skip]
+	pub type Unreleased = (
+		pallet_collator_selection::migration::v1::MigrateToV1<Runtime>,
+		pallet_multisig::migrations::v1::MigrateToV1<Runtime>,
+		InitStorageVersions,
+		cumulus_pallet_xcmp_queue::migration::v4::MigrationToV4<Runtime>,
+	);
+}
+
 /// Migration to initialize storage versions for pallets added after genesis.
 ///
 /// Ideally this would be done automatically (see