From fd8a4c94250e71ffefa9c1835c1bcceaaea8bb1c Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Tue, 6 Aug 2024 10:59:17 +1000 Subject: [PATCH 01/18] Update README.md added step-by-step guidelines --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index a9f0e905de..e492778a9e 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,26 @@ This will enable [`auto-merge`](https://docs.github.com/en/pull-requests/collabo The automation can be triggered by the author of the PR or any fellow whose GitHub handle is part of their identity. +## Release guidelines + +Here are the recommended steps for both major and minor runtime releases. + +|Steps |Description |Major |Minor | +|------|------------|------|------| +|0 |Open an issue for the release in the [runtimes repo](https://github.com/polkadot-fellows/runtimes/issues) with the **version number**. | ✔️ | ✔️ | +|1 |Identify **released crates**. | ✔️ | ❌ | +|2 |Identify and monitor **potential blockers** (old dependencies, pending or failed upgrades). | ✔️ | ✔️ | +|3 |Identify and include **priority PRs (fixes and patches)** with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | +|4 |Identify and include **recommended PRs** (enhancements, backports, migrations) with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | +|5 |Propose or include **additional PRs** (small configurations, simple migrations, general cleanup). | ✔️ | ✔️ | +|6 |Identify and communicate **potential breaking changes** (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or **disruptions**. Make sure to **ping @bkchr, @SBalaguer, and @anaelleltd** in your comment. | ✔️ | ✔️ | +|7 |Run **benchmarking** for changed pallets. | ✔️ | ✔️ | +|8 |Trigger the release for **final reviews**, including granular information about all breaking changes in the **CHANGELOG entry**. | ✔️ | ✔️ | +|9 |Create the **[whitelisting proposal (Fellowship)](https://github.com/joepetrowski/opengov-cli)** with contextual information.| ✔️ | ✔️ | +|10 |Create the **[whitelisted caller referendum (OpenGov)](https://github.com/joepetrowski/opengov-cli)** with contextual information and **instructions for following up** on breaking changes or disruptions. | ✔️ | ✔️ | +|11 |Close the issue for the release once the referendum is **approved and executed**. | ✔️ | ✔️ | +|12 |Open an issue for **the next release** in the runtimes repo, if applicable.| ❌ | ✔️ | + ## Release process Releases are automatically pushed on commits merged to master that fulfill the following requirements: From 3bf9aa4e0601f8890c652f89bae6ec497e65605d Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Tue, 6 Aug 2024 11:00:54 +1000 Subject: [PATCH 02/18] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e492778a9e..d03b5568d3 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ Here are the recommended steps for both major and minor runtime releases. |Steps |Description |Major |Minor | |------|------------|------|------| -|0 |Open an issue for the release in the [runtimes repo](https://github.com/polkadot-fellows/runtimes/issues) with the **version number**. | ✔️ | ✔️ | +|0 |Open an [issue](https://github.com/polkadot-fellows/runtimes/issues) for the release in the runtimes repo with the **version number**. | ✔️ | ✔️ | |1 |Identify **released crates**. | ✔️ | ❌ | |2 |Identify and monitor **potential blockers** (old dependencies, pending or failed upgrades). | ✔️ | ✔️ | |3 |Identify and include **priority PRs (fixes and patches)** with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | From a2725c8edbb884c53eb9f9d11bff08f082623833 Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Wed, 7 Aug 2024 12:42:06 +1000 Subject: [PATCH 03/18] Update README.md change section order --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d03b5568d3..1e759b5d57 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,17 @@ This will enable [`auto-merge`](https://docs.github.com/en/pull-requests/collabo The automation can be triggered by the author of the PR or any fellow whose GitHub handle is part of their identity. +## Release process + +Releases are automatically pushed on commits merged to master that fulfill the following requirements: + +- The [`CHANGELOG.md`](CHANGELOG.md) file was modified. +- The latest version (the version at the top of the file) in [`CHANGELOG.md`](CHANGELOG.md) has no tag in the repository. + +The release process is building all runtimes and then puts them into a release in this github repository. + +The format of [`CHANGELOG.md`](CHANGELOG.md) is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). + ## Release guidelines Here are the recommended steps for both major and minor runtime releases. @@ -70,16 +81,6 @@ Here are the recommended steps for both major and minor runtime releases. |11 |Close the issue for the release once the referendum is **approved and executed**. | ✔️ | ✔️ | |12 |Open an issue for **the next release** in the runtimes repo, if applicable.| ❌ | ✔️ | -## Release process - -Releases are automatically pushed on commits merged to master that fulfill the following requirements: - -- The [`CHANGELOG.md`](CHANGELOG.md) file was modified. -- The latest version (the version at the top of the file) in [`CHANGELOG.md`](CHANGELOG.md) has no tag in the repository. - -The release process is building all runtimes and then puts them into a release in this github repository. - -The format of [`CHANGELOG.md`](CHANGELOG.md) is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ## Communication channels From 8540cbfaa10e3f7b605a56e317730551173f579d Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Wed, 7 Aug 2024 12:49:49 +1000 Subject: [PATCH 04/18] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e759b5d57..ba15f67166 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ Here are the recommended steps for both major and minor runtime releases. |3 |Identify and include **priority PRs (fixes and patches)** with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | |4 |Identify and include **recommended PRs** (enhancements, backports, migrations) with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | |5 |Propose or include **additional PRs** (small configurations, simple migrations, general cleanup). | ✔️ | ✔️ | -|6 |Identify and communicate **potential breaking changes** (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or **disruptions**. Make sure to **ping @bkchr, @SBalaguer, and @anaelleltd** in your comment. | ✔️ | ✔️ | +|6 |Identify and communicate **potential breaking changes** (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or **disruptions**. Make sure to ping **@bkchr, @SBalaguer, and @anaelleltd** in your comment. | ✔️ | ✔️ | |7 |Run **benchmarking** for changed pallets. | ✔️ | ✔️ | |8 |Trigger the release for **final reviews**, including granular information about all breaking changes in the **CHANGELOG entry**. | ✔️ | ✔️ | |9 |Create the **[whitelisting proposal (Fellowship)](https://github.com/joepetrowski/opengov-cli)** with contextual information.| ✔️ | ✔️ | From 786312219ba2cfcca124834bd2643081ed6227e3 Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Tue, 13 Aug 2024 20:01:00 +1000 Subject: [PATCH 05/18] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ba15f67166..3b6c6565dd 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ Here are the recommended steps for both major and minor runtime releases. |3 |Identify and include **priority PRs (fixes and patches)** with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | |4 |Identify and include **recommended PRs** (enhancements, backports, migrations) with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | |5 |Propose or include **additional PRs** (small configurations, simple migrations, general cleanup). | ✔️ | ✔️ | -|6 |Identify and communicate **potential breaking changes** (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or **disruptions**. Make sure to ping **@bkchr, @SBalaguer, and @anaelleltd** in your comment. | ✔️ | ✔️ | +|6 |Identify and communicate all details about **potential breaking changes** (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or **disruptions**. Make sure to **ping @SBalaguer and @anaelleltd** in your commentary. | ✔️ | ✔️ | |7 |Run **benchmarking** for changed pallets. | ✔️ | ✔️ | |8 |Trigger the release for **final reviews**, including granular information about all breaking changes in the **CHANGELOG entry**. | ✔️ | ✔️ | |9 |Create the **[whitelisting proposal (Fellowship)](https://github.com/joepetrowski/opengov-cli)** with contextual information.| ✔️ | ✔️ | From dd19f8b582c3e92fdc35669adcc875cf420cfad3 Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Mon, 19 Aug 2024 10:48:17 +1000 Subject: [PATCH 06/18] Create pull_request_template.md --- docs/pull_request_template.md | 39 +++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/pull_request_template.md diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md new file mode 100644 index 0000000000..8f9a3bdf74 --- /dev/null +++ b/docs/pull_request_template.md @@ -0,0 +1,39 @@ + + +## I'm submitting a/n... + + - [ ] Priority PR (i.e fixes and patches) + - [ ] Recommended PR (i.e enhancements, backports, migrations) + - [ ] Additional PRs (i.e small configurations, simple migrations, general cleanup) + + +### What kind of changes does this PR introduce? + + + +### Who will be impacted by theses changes in practice? + + + +### How should impacted team/builders follow up on these changes? + + + From 0efa06b3043bc4c8f5eae04a9fd9964ca5074f02 Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Mon, 19 Aug 2024 10:52:17 +1000 Subject: [PATCH 07/18] Update pull_request_template.md --- docs/pull_request_template.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index 8f9a3bdf74..bff759bee2 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -4,6 +4,14 @@ and the [Runtime release guidelines](https://github.com/polkadot-fellows/runtime Use this PR template to communicate on the changes that you are proposing, to help streamline the release process, and to provide a course of action for impacted stakeholders. --> + + + + +- [ ] Does not require a CHANGELOG entry + + ## I'm submitting a/n... - + From 11b144cbd01d4a0b96ac849344794bb595f45425 Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Mon, 19 Aug 2024 11:01:33 +1000 Subject: [PATCH 09/18] Update pull_request_template.md --- docs/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index db98e5651f..a26a125db5 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -34,14 +34,14 @@ If submitting a breaking change, please make sure to ping @SBalaguer and @anaell ### Who will be impacted by theses changes in practice? ### How should impacted team/builders follow up on these changes? From 8953710f6656c192d702d59906e8e73de0777517 Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Mon, 19 Aug 2024 12:33:38 +1000 Subject: [PATCH 10/18] Update pull_request_template.md --- docs/pull_request_template.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index a26a125db5..33c2396b49 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -4,37 +4,30 @@ and the Runtime release guidelines at https://github.com/polkadot-fellows/runtim Use this PR template to streamline the release process, communicate on the changes that you are proposing, and provide a clear course of action for network stakeholders. --> - - - - -- [ ] Does not require a CHANGELOG entry - - -## I'm submitting a/n... +## I'm submitting... - - [ ] Priority PR (i.e fixes and patches) - - [ ] Recommended PR (i.e enhancements, backports, migrations) - - [ ] Additional PRs (i.e small configurations, simple migrations, general cleanup) + - [ ] a priority PR (i.e fixes and patches) + - [ ] a recommended PR (i.e enhancements, backports, migrations) + - [ ] an additional PR (i.e small configurations, simple migrations, general cleanup) ### What kind of changes does this PR introduce? ### Who will be impacted by theses changes in practice? @@ -42,6 +35,13 @@ Indicate the network stakeholders (i.e teams working on parachains, wallets, UIs +## Changelog + + + +- [ ] The CHANGELOG entry has been submitted +- [ ] Does not require a CHANGELOG entry From 3da364f8b729d07b77856dca080ce29930559a95 Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Wed, 21 Aug 2024 20:19:59 +1000 Subject: [PATCH 11/18] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b6c6565dd..2219fdceef 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ Here are the recommended steps for both major and minor runtime releases. |5 |Propose or include **additional PRs** (small configurations, simple migrations, general cleanup). | ✔️ | ✔️ | |6 |Identify and communicate all details about **potential breaking changes** (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or **disruptions**. Make sure to **ping @SBalaguer and @anaelleltd** in your commentary. | ✔️ | ✔️ | |7 |Run **benchmarking** for changed pallets. | ✔️ | ✔️ | -|8 |Trigger the release for **final reviews**, including granular information about all breaking changes in the **CHANGELOG entry**. | ✔️ | ✔️ | +|8 |Trigger the release for **final reviews**, making sure to highlight information about all breaking changes or disruptions in the **CHANGELOG entry**. | ✔️ | ✔️ | |9 |Create the **[whitelisting proposal (Fellowship)](https://github.com/joepetrowski/opengov-cli)** with contextual information.| ✔️ | ✔️ | |10 |Create the **[whitelisted caller referendum (OpenGov)](https://github.com/joepetrowski/opengov-cli)** with contextual information and **instructions for following up** on breaking changes or disruptions. | ✔️ | ✔️ | |11 |Close the issue for the release once the referendum is **approved and executed**. | ✔️ | ✔️ | From c1c927b7ea4f21ac3a9834d6f467c8e56b23d471 Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Wed, 21 Aug 2024 22:24:37 +1000 Subject: [PATCH 12/18] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2219fdceef..dd534350d8 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ Here are the recommended steps for both major and minor runtime releases. |1 |Identify **released crates**. | ✔️ | ❌ | |2 |Identify and monitor **potential blockers** (old dependencies, pending or failed upgrades). | ✔️ | ✔️ | |3 |Identify and include **priority PRs (fixes and patches)** with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | -|4 |Identify and include **recommended PRs** (enhancements, backports, migrations) with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | +|4 |Identify and include **recommended PRs** (enhancements, migrations, backports) with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | |5 |Propose or include **additional PRs** (small configurations, simple migrations, general cleanup). | ✔️ | ✔️ | |6 |Identify and communicate all details about **potential breaking changes** (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or **disruptions**. Make sure to **ping @SBalaguer and @anaelleltd** in your commentary. | ✔️ | ✔️ | |7 |Run **benchmarking** for changed pallets. | ✔️ | ✔️ | From c29ece8d5693d1374594d7c0b27fff57cb364a09 Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Fri, 23 Aug 2024 10:28:45 +1000 Subject: [PATCH 13/18] Update README.md remove PR categories --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index dd534350d8..d4013fb622 100644 --- a/README.md +++ b/README.md @@ -70,16 +70,14 @@ Here are the recommended steps for both major and minor runtime releases. |0 |Open an [issue](https://github.com/polkadot-fellows/runtimes/issues) for the release in the runtimes repo with the **version number**. | ✔️ | ✔️ | |1 |Identify **released crates**. | ✔️ | ❌ | |2 |Identify and monitor **potential blockers** (old dependencies, pending or failed upgrades). | ✔️ | ✔️ | -|3 |Identify and include **priority PRs (fixes and patches)** with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | -|4 |Identify and include **recommended PRs** (enhancements, migrations, backports) with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | -|5 |Propose or include **additional PRs** (small configurations, simple migrations, general cleanup). | ✔️ | ✔️ | -|6 |Identify and communicate all details about **potential breaking changes** (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or **disruptions**. Make sure to **ping @SBalaguer and @anaelleltd** in your commentary. | ✔️ | ✔️ | -|7 |Run **benchmarking** for changed pallets. | ✔️ | ✔️ | -|8 |Trigger the release for **final reviews**, making sure to highlight information about all breaking changes or disruptions in the **CHANGELOG entry**. | ✔️ | ✔️ | -|9 |Create the **[whitelisting proposal (Fellowship)](https://github.com/joepetrowski/opengov-cli)** with contextual information.| ✔️ | ✔️ | -|10 |Create the **[whitelisted caller referendum (OpenGov)](https://github.com/joepetrowski/opengov-cli)** with contextual information and **instructions for following up** on breaking changes or disruptions. | ✔️ | ✔️ | -|11 |Close the issue for the release once the referendum is **approved and executed**. | ✔️ | ✔️ | -|12 |Open an issue for **the next release** in the runtimes repo, if applicable.| ❌ | ✔️ | +|3 |Identify and include **PRs** with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | +|4 |Identify and communicate all details about **potential breaking changes** (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or **disruptions**. Make sure to **ping @SBalaguer and @anaelleltd** in your commentary. | ✔️ | ✔️ | +|5 |Run **benchmarking** for changed pallets. | ✔️ | ✔️ | +|6 |Trigger the release for **final reviews**, making sure to highlight information about all breaking changes or disruptions in the **CHANGELOG entry**. | ✔️ | ✔️ | +|7 |Create the **[whitelisting proposal (Fellowship)](https://github.com/joepetrowski/opengov-cli)** with contextual information.| ✔️ | ✔️ | +|8 |Create the **[whitelisted caller referendum (OpenGov)](https://github.com/joepetrowski/opengov-cli)** with contextual information and **instructions for following up** on breaking changes or disruptions. | ✔️ | ✔️ | +|9 |Close the issue for the release once the referendum is **approved and executed**. | ✔️ | ✔️ | +|10 |Open an issue for **the next release** in the runtimes repo, if applicable.| ❌ | ✔️ | ## Communication channels From a19e62d8ebe665a7485e75f6454d13f03633ebe8 Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Fri, 23 Aug 2024 10:39:33 +1000 Subject: [PATCH 14/18] Update pull_request_template.md --- docs/pull_request_template.md | 39 ++++++++--------------------------- 1 file changed, 9 insertions(+), 30 deletions(-) diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index 33c2396b49..a83674303a 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -4,44 +4,23 @@ and the Runtime release guidelines at https://github.com/polkadot-fellows/runtim Use this PR template to streamline the release process, communicate on the changes that you are proposing, and provide a clear course of action for network stakeholders. --> -## I'm submitting... - - [ ] a priority PR (i.e fixes and patches) - - [ ] a recommended PR (i.e enhancements, backports, migrations) - - [ ] an additional PR (i.e small configurations, simple migrations, general cleanup) - -### What kind of changes does this PR introduce? - - - -### Who will be impacted by theses changes in practice? - -### How should impacted team/builders follow up on these changes? -## Changelog - - -- [ ] The CHANGELOG entry has been submitted + - [ ] Does not require a CHANGELOG entry - From 3fab28603c4b08c3c38120e4a0aae1953c3e04b9 Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Fri, 23 Aug 2024 20:50:57 +1000 Subject: [PATCH 15/18] Update pull_request_template.md --- docs/pull_request_template.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index a83674303a..0a8b80548e 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -8,16 +8,12 @@ Use this PR template to streamline the release process, communicate on the chang 1) What kind of changes does this PR introduce? Indicate if merging this PR will result in breaking changes (e.g. changes to transaction/event/error encoding, polkadot-sdk migrations, or XCM and storage format) or disruptions for network stakeholders. When submitting a breaking change, please make sure to ping @SBalaguer and @anaelleltd so that they can notify ecosystem teams and builders. -Otherwise, ignore sections 1, 2, and 3. +Otherwise, ignore sections 1 and 2. --> - - From ffb96c8838abe6b3a46ca77efbad2ab08b00b11d Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Mon, 2 Sep 2024 10:16:51 +1000 Subject: [PATCH 16/18] Update README.md added links to available doc --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d4013fb622..fdaff8bd0d 100644 --- a/README.md +++ b/README.md @@ -68,11 +68,11 @@ Here are the recommended steps for both major and minor runtime releases. |Steps |Description |Major |Minor | |------|------------|------|------| |0 |Open an [issue](https://github.com/polkadot-fellows/runtimes/issues) for the release in the runtimes repo with the **version number**. | ✔️ | ✔️ | -|1 |Identify **released crates**. | ✔️ | ❌ | +|1 |Identify **[released crates](https://github.com/paritytech/polkadot-sdk?tab=readme-ov-file#-releases)**. | ✔️ | ❌ | |2 |Identify and monitor **potential blockers** (old dependencies, pending or failed upgrades). | ✔️ | ✔️ | |3 |Identify and include **PRs** with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | |4 |Identify and communicate all details about **potential breaking changes** (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or **disruptions**. Make sure to **ping @SBalaguer and @anaelleltd** in your commentary. | ✔️ | ✔️ | -|5 |Run **benchmarking** for changed pallets. | ✔️ | ✔️ | +|5 |Run **[benchmarking](https://github.com/polkadot-fellows/runtimes/blob/main/docs/weight-generation.md)** for changed pallets. | ✔️ | ✔️ | |6 |Trigger the release for **final reviews**, making sure to highlight information about all breaking changes or disruptions in the **CHANGELOG entry**. | ✔️ | ✔️ | |7 |Create the **[whitelisting proposal (Fellowship)](https://github.com/joepetrowski/opengov-cli)** with contextual information.| ✔️ | ✔️ | |8 |Create the **[whitelisted caller referendum (OpenGov)](https://github.com/joepetrowski/opengov-cli)** with contextual information and **instructions for following up** on breaking changes or disruptions. | ✔️ | ✔️ | From ae3b3f7a12ce26feb2865f6e310950a7ef1bc2fc Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Tue, 3 Sep 2024 09:43:17 +1000 Subject: [PATCH 17/18] Update README.md removed references to major & minor releases --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index fdaff8bd0d..cae9948e4f 100644 --- a/README.md +++ b/README.md @@ -63,21 +63,21 @@ The format of [`CHANGELOG.md`](CHANGELOG.md) is based on [Keep a Changelog](http ## Release guidelines -Here are the recommended steps for both major and minor runtime releases. - -|Steps |Description |Major |Minor | -|------|------------|------|------| -|0 |Open an [issue](https://github.com/polkadot-fellows/runtimes/issues) for the release in the runtimes repo with the **version number**. | ✔️ | ✔️ | -|1 |Identify **[released crates](https://github.com/paritytech/polkadot-sdk?tab=readme-ov-file#-releases)**. | ✔️ | ❌ | -|2 |Identify and monitor **potential blockers** (old dependencies, pending or failed upgrades). | ✔️ | ✔️ | -|3 |Identify and include **PRs** with required tests, highlighting the integration tests that have changed. | ✔️ | ✔️ | -|4 |Identify and communicate all details about **potential breaking changes** (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or **disruptions**. Make sure to **ping @SBalaguer and @anaelleltd** in your commentary. | ✔️ | ✔️ | -|5 |Run **[benchmarking](https://github.com/polkadot-fellows/runtimes/blob/main/docs/weight-generation.md)** for changed pallets. | ✔️ | ✔️ | -|6 |Trigger the release for **final reviews**, making sure to highlight information about all breaking changes or disruptions in the **CHANGELOG entry**. | ✔️ | ✔️ | -|7 |Create the **[whitelisting proposal (Fellowship)](https://github.com/joepetrowski/opengov-cli)** with contextual information.| ✔️ | ✔️ | -|8 |Create the **[whitelisted caller referendum (OpenGov)](https://github.com/joepetrowski/opengov-cli)** with contextual information and **instructions for following up** on breaking changes or disruptions. | ✔️ | ✔️ | -|9 |Close the issue for the release once the referendum is **approved and executed**. | ✔️ | ✔️ | -|10 |Open an issue for **the next release** in the runtimes repo, if applicable.| ❌ | ✔️ | +Here is an overview of the recommended steps. + +|Steps |Description | +|------|------------| +|0 |Open an [issue](https://github.com/polkadot-fellows/runtimes/issues) for the release in the runtimes repo with the **version number**. | +|1 |Identify **[released crates](https://github.com/paritytech/polkadot-sdk?tab=readme-ov-file#-releases)** and update polkadot-sdk, if applicable. | +|2 |Identify and monitor **potential blockers** (old dependencies, pending or failed upgrades). | +|3 |Identify and include **PRs** with required tests, highlighting the integration tests that have changed. | +|4 |Identify and communicate all details about **potential breaking changes** (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or **disruptions**. Make sure to **ping @SBalaguer and @anaelleltd** in your commentary. | +|5 |Run **[benchmarking](https://github.com/polkadot-fellows/runtimes/blob/main/docs/weight-generation.md)** for changed pallets. | +|6 |Trigger the release for **final reviews**, making sure to highlight information about all breaking changes or disruptions in the **CHANGELOG entry**. | +|7 |Create the **[whitelisting proposal (Fellowship)](https://github.com/joepetrowski/opengov-cli)** with contextual information.| +|8 |Create the **[whitelisted caller referendum (OpenGov)](https://github.com/joepetrowski/opengov-cli)** with contextual information and **instructions for following up** on breaking changes or disruptions. | +|9 |Close the issue for the release once the referendum is **approved and executed**. | +|10 |Open an issue for **the next release** in the runtimes repo, if applicable.| ## Communication channels From 9f51d366f8ee2f24a2f7341b00c8f6d3a057bcb3 Mon Sep 17 00:00:00 2001 From: Anaelle LTD <44770354+anaelleltd@users.noreply.github.com> Date: Tue, 3 Sep 2024 11:42:58 +1000 Subject: [PATCH 18/18] Update README.md reference polkadot-sdk --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cae9948e4f..d46a2d472e 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ Here is an overview of the recommended steps. |Steps |Description | |------|------------| |0 |Open an [issue](https://github.com/polkadot-fellows/runtimes/issues) for the release in the runtimes repo with the **version number**. | -|1 |Identify **[released crates](https://github.com/paritytech/polkadot-sdk?tab=readme-ov-file#-releases)** and update polkadot-sdk, if applicable. | +|1 |Update **[polkadot-sdk](https://github.com/paritytech/polkadot-sdk?tab=readme-ov-file#-releases)**, if applicable. | |2 |Identify and monitor **potential blockers** (old dependencies, pending or failed upgrades). | |3 |Identify and include **PRs** with required tests, highlighting the integration tests that have changed. | |4 |Identify and communicate all details about **potential breaking changes** (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or **disruptions**. Make sure to **ping @SBalaguer and @anaelleltd** in your commentary. |