Runtime Upgrade ref docs and Single Block Migration example pallet #1554
Merged
liamaharon merged 110 commits intomasterfrom Feb 28, 2024
Merged
Runtime Upgrade ref docs and Single Block Migration example pallet #1554liamaharon merged 110 commits intomasterfrom
liamaharon merged 110 commits intomasterfrom
Conversation
…-migrations-reference-docs
liamaharon
added
T1-FRAME
kianenigma
reviewed
Jan 8, 2024
docs/sdk/src/reference_docs/frame_runtime_upgrades_and_migrations.rs
Outdated
Show resolved
Hide resolved
kianenigma
reviewed
Jan 8, 2024
docs/sdk/src/reference_docs/frame_runtime_upgrades_and_migrations.rs
Outdated
Show resolved
Hide resolved
kianenigma
approved these changes
Jan 8, 2024
Contributor
kianenigma
left a comment
kianenigma
left a comment
There was a problem hiding this comment.
Didn't review everything but given the size of the PR and the overall good quality, it can be merged and then iterated upon later.
…ons.rs Co-authored-by: gupnik <[email protected]>
…h/polkadot-sdk into liam-migrations-reference-docs
ordian
added a commit
that referenced
this pull request
Feb 28, 2024
…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) ...
bgallois
pushed a commit
to duniter/duniter-polkadot-sdk
that referenced
this pull request
Mar 25, 2024
…aritytech#1554) Closes paritytech/polkadot-sdk-docs#55 - Changes 'current storage version' terminology to less ambiguous 'in-code storage version' (suggestion by @ggwpez) - Adds a new example pallet `pallet-example-single-block-migrations` - Adds a new reference doc to replace https://docs.substrate.io/maintain/runtime-upgrades/ (temporarily living in the pallet while we wait for developer hub PR to merge) - Adds documentation for the `storage_alias` macro - Improves `trait Hooks` docs - Improves `trait GetStorageVersion` docs - Update the suggested patterns for using `VersionedMigration`, so that version unchecked migrations are never exported - Prevents accidental usage of version unchecked migrations in runtimes paritytech/substrate#14421 (comment) - Unversioned migration code is kept inside `mod version_unchecked`, versioned code is kept in `pub mod versioned` - It is necessary to use modules to limit visibility because the inner migration must be `pub`. See rust-lang/rust#30905 and https://internals.rust-lang.org/t/lang-team-minutes-private-in-public-rules/4504/40 for more. ### todo - [x] move to reference docs to proper place within sdk-docs (now that paritytech#2102 is merged) - [x] prdoc --------- Co-authored-by: Kian Paimani <[email protected]> Co-authored-by: Juan <[email protected]> Co-authored-by: Oliver Tale-Yazdi <[email protected]> Co-authored-by: command-bot <> Co-authored-by: gupnik <[email protected]>
5 tasks
This was referenced Jun 5, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes paritytech/polkadot-sdk-docs#55
pallet-example-single-block-migrationsstorage_aliasmacrotrait Hooksdocstrait GetStorageVersiondocsVersionedMigration, so that version unchecked migrations are never exportedFix Society v2 migration substrate#14421 (comment)
mod version_unchecked, versioned code is kept inpub mod versionedpub. See "error: private type in public interface" in private module rust-lang/rust#30905 andhttps://internals.rust-lang.org/t/lang-team-minutes-private-in-public-rules/4504/40 for more.
todo
developer_hub#2102 is merged)