Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update release template #2092

Merged
merged 8 commits into from
Jul 23, 2024
Merged

Update release template #2092

merged 8 commits into from
Jul 23, 2024

Conversation

wilwade
Copy link
Collaborator

@wilwade wilwade commented Jul 22, 2024 •
edited
Loading

Goal

The goal of this PR is to make various minor improvements to our release content

Closes #1800

Discussion

  • Add sections for changes/breaking and changes/storage-migration labels
  • Remove deployment section from RC releases
  • Highlight the metadata changes
  • Update github actions
  • Corrected Polkadot-SDK Version code

Example Release: https://github.com/frequency-chain/frequency/releases/tag/v0.0.1-rc6

Test the release summary

  • Compare it to mainnet polkadot:
    • docker run jacogr/polkadot-js-tools:0.57.1 metadata wss://0.rpc.frequency.xyz wss://polkadot-rpc.publicnode.com >> /tmp/metadata-compare-mainnet.txt
  • Run the summarizer
    • ./tools/ci/scripts/extrinsic-ordering-filter.sh /tmp/metadata-compare-mainnet.txt

Expected output:

------------------------------ SUMMARY -------------------------------
⚠️ This filter is here to help spotting changes that should be reviewed carefully.
⚠️ It catches only index changes, deletions and value decreases.

## Modules
- Added
  - Sudo, Passkey
  - Babe, Indices, Staking, Offences, Historical
- Removed
  - ParachainSystem
  - ParachainSystem, ParachainInfo, Democracy, Council, TechnicalCommittee

## Removals
- Balances
  - [-] calls: setBalanceDeprecated, transfer
- CollatorSelection
  - [-] storage: candidates
- Balances
  - [-] calls: setBalanceDeprecated, transfer

## Additions
- System
  - [+] calls: authorizeUpgrade, authorizeUpgradeWithoutChecks, applyAuthorizedUpgrade
  - [+] storage: authorizedUpgrade
- Preimage
  - [+] calls: ensureUpdated
  - [+] storage: requestStatusFor
- Balances
  - [+] calls: forceAdjustTotalIssuance
- Treasury
  - [+] calls: spendLocal, payout, checkStatus, voidSpend
  - [+] storage: spendCount, spends
- CollatorSelection
  - [+] calls: updateBond, takeCandidateSlot
  - [+] storage: candidateList
- System
  - [+] calls: authorizeUpgrade, authorizeUpgradeWithoutChecks, applyAuthorizedUpgrade
  - [+] storage: authorizedUpgrade
- Preimage
  - [+] calls: ensureUpdated
  - [+] storage: requestStatusFor
- Balances
  - [+] calls: forceAdjustTotalIssuance
- Treasury
  - [+] calls: spendLocal, payout, checkStatus, voidSpend
  - [+] storage: spendCount, spends

## Changes
- Preimage
  - [statusFor] value: PalletPreimageRequestStatus -> PalletPreimageOldRequestStatus
- Treasury
  - [spend] idx: 3 -> 5 (args: 2 -> 4)
- Preimage
  - [statusFor] value: PalletPreimageRequestStatus -> PalletPreimageOldRequestStatus
- Treasury
  - [spend] idx: 3 -> 5 (args: 2 -> 4)
- Session
  - [setKeys] idx: 0 (args: 2)
  - [queuedKeys] type: Vec<(AccountId32,FrequencyRuntimeSessionKeys)> -> Vec<(AccountId32,PolkadotRuntimeSessionKeys)>
  - [nextKeys] value: FrequencyRuntimeSessionKeys -> PolkadotRuntimeSessionKeys
- Proxy
  - [proxy] idx: 0 (args: 3)
  - [addProxy] idx: 1 (args: 3)
  - [removeProxy] idx: 2 (args: 3)
  - [createPure] idx: 4 (args: 3)
  - [killPure] idx: 5 (args: 5)
  - [proxyAnnounced] idx: 9 (args: 4)

----------------------------------------------------------------------

wilwade
wilwade commented Jul 22, 2024
View reviewed changes
.github/workflows/release.yml
@@ -586,14 +586,13 @@ jobs:
- name: Compare Metadata
timeout-minutes: 10
run: |
CMD="docker run --pull always --net=net-${{env.RELEASE_BRANCH_NAME}} jacogr/polkadot-js-tools:0.55.3 metadata ws://ref-node:9944 ws://test-node:9944"
CMD="docker run --pull always --net=net-${{env.RELEASE_BRANCH_NAME}} jacogr/polkadot-js-tools:0.57.1 metadata ws://ref-node:9944 ws://test-node:9944"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing special with this version upgrade, but went ahead with it

wilwade
wilwade commented Jul 22, 2024
View reviewed changes
.github/workflows/release.yml
echo -e "Running:\n$CMD"
$CMD >> ${{env.OUTPUT_DIR}}/${{env.OUTPUT_FILENAME}}
sed -z -i 's/\n\n/\n/g' ${{env.OUTPUT_DIR}}/${{env.OUTPUT_FILENAME}}
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't want to remove the line breaks because the new summary code needs it

wilwade
wilwade commented Jul 22, 2024
View reviewed changes
.github/workflows/release.yml
cat ${{env.OUTPUT_DIR}}/${{env.OUTPUT_FILENAME}} | egrep -n -i ''
SUMMARY=$(./tools/ci/scripts/extrinsic-ordering-filter.sh ${{env.OUTPUT_DIR}}/${{env.OUTPUT_FILENAME}})
echo -e $SUMMARY
echo -e $SUMMARY >> ${{env.OUTPUT_DIR}}/${{env.OUTPUT_FILENAME}}
echo -e "$SUMMARY"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure that summary code outputs correctly

wilwade
wilwade commented Jul 22, 2024
View reviewed changes
tools/ci/scripts/extrinsic-ordering-filter.sh
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair amount of rework here to get the better summary output

@wilwade wilwade requested review from a team, shannonwells, mattheworris, enddynayn, aramikm, claireolmstead and JoeCap08055 and removed request for a team July 22, 2024 23:06
@wilwade wilwade marked this pull request as ready for review July 22, 2024 23:06
@wilwade wilwade requested a review from demisx as a code owner July 22, 2024 23:06
@wilwade wilwade enabled auto-merge (squash) July 22, 2024 23:06
mattheworris
mattheworris approved these changes Jul 22, 2024
View reviewed changes
Copy link
Collaborator

@mattheworris mattheworris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢 it!

shannonwells
shannonwells approved these changes Jul 22, 2024
View reviewed changes
Copy link
Collaborator

@shannonwells shannonwells left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works on my machine

JoeCap08055
JoeCap08055 approved these changes Jul 23, 2024
View reviewed changes
Copy link
Collaborator

@JoeCap08055 JoeCap08055 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢 it!

@wilwade wilwade merged commit 4822f39 into main Jul 23, 2024
48 checks passed
@wilwade wilwade deleted the chore/update-release-template-1800 branch July 23, 2024 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JoeCap08055 JoeCap08055 JoeCap08055 approved these changes

@mattheworris mattheworris mattheworris approved these changes

@shannonwells shannonwells shannonwells approved these changes

@enddynayn enddynayn Awaiting requested review from enddynayn enddynayn was automatically assigned from frequency-chain/pr-reviewers

@aramikm aramikm Awaiting requested review from aramikm aramikm was automatically assigned from frequency-chain/pr-reviewers

@claireolmstead claireolmstead Awaiting requested review from claireolmstead claireolmstead was automatically assigned from frequency-chain/pr-reviewers

@demisx demisx Awaiting requested review from demisx demisx is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update Release Template
4 participants
@wilwade @shannonwells @mattheworris @JoeCap08055