Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Release notes fixes #5494

Merged
merged 9 commits into from
May 11, 2022
Merged

Release notes fixes #5494

merged 9 commits into from
May 11, 2022

Conversation

chevdor
Copy link
Contributor

@chevdor chevdor commented May 11, 2022

This is a rework of the release notes content that also allows including manual notes to the release notes.
Users can now submit edits for the _free_notes.md.tera file under scripts/ci/changelog/template.

To test yourself, you may get the context.json file from https://github.com/paritytech/polkadot/actions/runs/2257759168 and store it under the changelog folder.

Create and load a .env such as:

RUSTC_STABLE="rustc 1.56.1 (59eed8a2a 2021-11-01)"
RUSTC_NIGHTLY="rustc 1.57.0-nightly (51e514c0f 2021-09-12)"
PRE_RELEASE=true
HIDE_SRTOOL_SHELL=true
REF1=refs/tags/v0.9.18
REF2=refs/tags/v0.9.19
DEBUG=1
NO_CACHE=1

and with tera installed, run:

tera --env --env-key env --include-path templates --template templates/template.md.tera context.json > /tmp/relnotes.md

@chevdor chevdor added A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). A0-please_review Pull request needs code review. B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. labels May 11, 2022
@chevdor chevdor requested a review from a team as a code owner May 11, 2022 08:06
@paritytech-ci paritytech-ci requested a review from a team May 11, 2022 08:55
@chevdor chevdor merged commit 904c611 into master May 11, 2022
@chevdor chevdor deleted the wk-releasenotes-fixes branch May 11, 2022 09:20
chevdor added a commit that referenced this pull request May 11, 2022
* Move compiler information below priority information

* Show docker section by default

* Show a mention even if there are no host functions

* Fix the wording for the migrations

* Fix some wording

* Include free notes section

* Fix spacing issue

* Rename the free notes template

* Few minor changes including reworking the tag rendering
chevdor added a commit that referenced this pull request May 11, 2022
* Move compiler information below priority information

* Show docker section by default

* Show a mention even if there are no host functions

* Fix the wording for the migrations

* Fix some wording

* Include free notes section

* Fix spacing issue

* Rename the free notes template

* Few minor changes including reworking the tag rendering
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A0-please_review Pull request needs code review. 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 C1-low PR touches the given topic and has a low impact on builders.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants