Add changelog generation by chevdor · Pull Request #761 · paritytech/cumulus

chevdor · 2021-11-15T09:07:55Z

This PR introduces a new workflow_dispatch workflow that can be used to:

build the runtimes
build the release notes (including changes from polkadot and substrate)
create the draft release based off those release notes
attach the runtimes to the draft release
annouce the draft in an Element channel

apopiak · 2021-11-19T15:38:48Z

.github/workflows/draft_release.yml

+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        runtime: ["shell", "statemine", "statemint", "westmint", "rococo"]


I don't see the need for building the shell and rococo chains by default. We're not going to be releasing them again any time soon.

Those are built in parallel so there is no time penalty.
They will NOT but showing up in the release notes thanks to those lines.

Moreover, I cannot simply remove those from here as those rutime data are expected here.

We can improve later I think.

There is also a benefit, they will be built and attached which makes it easy for us when we need them.

scripts/changelog/.env

scripts/changelog/templates/change.md.tera

apopiak · 2021-11-19T15:42:59Z

scripts/changelog/templates/change.md.tera

+{%- set audit = "✅ trivial " -%}
+{%- elif c.meta.D and c.meta.D.value == 3 -%}
+{%- set audit = "✅ trivial " -%}


should these be the same

The audit section is actually commented out with {# ... #} (see here) so the audit part is not active yet.

scripts/changelog/templates/change.md.tera

apopiak · 2021-11-19T15:44:33Z

scripts/changelog/templates/host_functions.md.tera

+{% if host_fn_count == 0 -%}
+ℹ️ This release does not contain any new host functions.
+{% elif host_fn_count == 1 -%}
+⚠️ The runtimes in this release contain one new **host function**.


I would skip the whole section if none were detected

~~Sure, I will leave us a comment so we know it was just not skipped for no reason but I can hide this to the user.~~

Hmm this is actually what I initially went for initially but I currently do not know the count ahead of time.
So I run thru the list, keep counting and display the list, thne comes this message.
So if I display nothing that will look like a weird section with no content.

I agree with your goal but the tooling currently does not allow it.

ok, it's trivial to delete manually, I'd say

Co-authored-by: Alexander Popiak <alexander.popiak@parity.io>

* master: Add changelog generation (#761) Moving `pallet-asset-tx-payment` from cumulus to substrate (#712)

* WIP Release notes generation and templates * WIP Add new sections to the template * WIP renaming and wip * Fix runtime template * Add doc, NO_CACHE and tweaking of the templates * Renaming cl into cumulus to make room for the polkadot and substrate * Fetch data from Substrate and Polkadot * WIP convert bash script to ruby * Convert to Ruby * Fix host function delection * Extract priority to a macro * Fix misc changes * Draft release workflow * Fix runtime dir * Add ENV to ignore runtimes * Install tooling separately * WIP troubleshooting - remove sudo * Minor formatting fixes * Fix workflow * Add missing dep * Linting * Fix changelog script * Add missing tera install * Use absolute paths * Fix path + cleanup * Fix changelog generation * Add missing pre-release ENV * Fix rust version ENV * Fix release notes path * Fix output * Fix runtime_dir for cumulus * Fix ENV substitutions * Fix styling * Debugging * Styling * Fix call to fetch the runtime version * Cleanup and doc * Delete sample .env * Update scripts/changelog/templates/change.md.tera Co-authored-by: Alexander Popiak <alexander.popiak@parity.io> * Change XCM emoji marker for a ✉️ Co-authored-by: Alexander Popiak <alexander.popiak@parity.io>

* WIP Release notes generation and templates * WIP Add new sections to the template * WIP renaming and wip * Fix runtime template * Add doc, NO_CACHE and tweaking of the templates * Renaming cl into cumulus to make room for the polkadot and substrate * Fetch data from Substrate and Polkadot * WIP convert bash script to ruby * Convert to Ruby * Fix host function delection * Extract priority to a macro * Fix misc changes * Draft release workflow * Fix runtime dir * Add ENV to ignore runtimes * Install tooling separately * WIP troubleshooting - remove sudo * Minor formatting fixes * Fix workflow * Add missing dep * Linting * Fix changelog script * Add missing tera install * Use absolute paths * Fix path + cleanup * Fix changelog generation * Add missing pre-release ENV * Fix rust version ENV * Fix release notes path * Fix output * Fix runtime_dir for cumulus * Fix ENV substitutions * Fix styling * Debugging * Styling * Fix call to fetch the runtime version * Cleanup and doc * Delete sample .env * Update scripts/changelog/templates/change.md.tera Co-authored-by: Alexander Popiak <alexander.popiak@parity.io> * Change XCM emoji marker for a ✉️ Co-authored-by: Alexander Popiak <alexander.popiak@parity.io> Co-authored-by: Alexander Popiak <alexander.popiak@parity.io>

chevdor force-pushed the wk-changelog branch 2 times, most recently from 1f63e11 to 41eb6c8 Compare November 15, 2021 13:17

chevdor requested review from apopiak and s3krit November 19, 2021 15:29

chevdor added A0-pleasereview A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). B0-silent Changes should not be mentioned in any release notes labels Nov 19, 2021

chevdor added 23 commits November 19, 2021 16:33

WIP Release notes generation and templates

e752f30

WIP Add new sections to the template

ac0be3e

WIP renaming and wip

e5c0156

Fix runtime template

a85432f

Add doc, NO_CACHE and tweaking of the templates

d42130b

WIP

e8f3ef0

Renaming cl into cumulus to make room for the polkadot and substrate

df18ca9

Fetch data from Substrate and Polkadot

8766d51

WIP convert bash script to ruby

9ed574e

Convert to Ruby

61be28c

Cleanup

e1b2a13

Fix typo

38981c9

Cleanup

9f9d355

Fix host function delection

1ac54a2

Extract priority to a macro

b3397a5

Cleanup

54b24b5

Fix misc changes

9f70235

Draft release workflow

1a77940

Fix runtime dir

814a184

Add ENV to ignore runtimes

adbfc88

Install tooling separately

2362201

WIP troubleshooting - remove sudo

66ae85d

Minor formatting fixes

a26cf4a

chevdor added 17 commits November 19, 2021 16:37

Fix changelog script

3fc9711

Add missing tera install

eeaa8c8

Use absolute paths

1b373e5

Fix path + cleanup

3dc122d

Fix changelog generation

043d4e1

Add missing pre-release ENV

87e18fa

Fix rust version ENV

6b75d61

Fix release notes path

3caa807

Fix output

403bc22

Fix runtime_dir for cumulus

68fecf0

Fix

363c537

Fix ENV substitutions

d4a5073

Fix styling

2ae9c75

Debugging

8b2f22b

Styling

3da8fd8

Fix call to fetch the runtime version

9a9453f

Cleanup and doc

a386d15

chevdor force-pushed the wk-changelog branch from 2d18a6f to a386d15 Compare November 19, 2021 15:38

chevdor marked this pull request as ready for review November 19, 2021 15:38

Delete sample .env

a6c9ba9

apopiak approved these changes Nov 19, 2021

View reviewed changes

chevdor and others added 2 commits November 19, 2021 16:58

Update scripts/changelog/templates/change.md.tera

68cb0ed

Co-authored-by: Alexander Popiak <alexander.popiak@parity.io>

Change XCM emoji marker for a ✉️

6265a1c

chevdor merged commit ce24038 into master Nov 19, 2021

chevdor deleted the wk-changelog branch November 19, 2021 16:30

ordian added a commit that referenced this pull request Nov 19, 2021

Merge branch 'master' into rk-dispute-participation

fb6b2cc

* master: Add changelog generation (#761) Moving `pallet-asset-tx-payment` from cumulus to substrate (#712)

chevdor mentioned this pull request Nov 22, 2021

Fix CI for runtimes and rococo #774

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add changelog generation#761

Add changelog generation#761
chevdor merged 46 commits intomasterfrom
wk-changelog

chevdor commented Nov 15, 2021 •

edited

Loading

Uh oh!

apopiak Nov 19, 2021

Uh oh!

chevdor Nov 19, 2021

Uh oh!

chevdor Nov 19, 2021

Uh oh!

Uh oh!

Uh oh!

apopiak Nov 19, 2021

Uh oh!

chevdor Nov 19, 2021 •

edited

Loading

Uh oh!

apopiak Nov 19, 2021

Uh oh!

Uh oh!

apopiak Nov 19, 2021

Uh oh!

chevdor Nov 19, 2021 •

edited

Loading

Uh oh!

chevdor Nov 19, 2021

Uh oh!

apopiak Nov 19, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

chevdor commented Nov 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chevdor Nov 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chevdor Nov 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

chevdor commented Nov 15, 2021 •

edited

Loading

chevdor Nov 19, 2021 •

edited

Loading

chevdor Nov 19, 2021 •

edited

Loading