Changelog

Currently, the changelog is built locally. It will be moved to CI once labels stabilize.

For now, a bit of preparation is required before you can run the script:

fetch the srtool digests
store them under the digests folder as <chain>-srtool-digest.json
ensure the .env file is up to date with correct information. See below for an example

The content of the release notes is generated from the template files under the scripts/ci/changelog/templates folder. For readability and maintenance, the template is split into several small snippets.

Run:

./bin/changelog <ref_until> [<ref_since>]

For instance:

./bin/changelog v0.9.18

A file called release-notes.md will be generated and can be used for the release.

ENV

You may use the following ENV for testing:

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
DEBUG=1
NO_CACHE=1

Considered labels

The following list will likely evolve over time and it will be hard to keep it in sync. In any case, if you want to find all the labels that are used, search for meta in the templates. Currently, the considered labels are:

Priority: C labels
Audit: D labels
E4 => new host function
E2 => database migration
B0 => silent, not showing up
B1 => noteworthy
T0 => node
T1 => runtime

Note that labels with the same letter are mutually exclusive. A PR should not have both B0 and B5, or both C1 and C9. In case of conflicts, the template will decide which label will be considered.

Dev and debuggin

Hot Reload

The following command allows Hot Reload:

fswatch templates -e ".*\.md$" | xargs -n1 -I{} ./bin/changelog v0.9.18

Caching

By default, if the changelog data from Github is already present, the calls to the Github API will be skipped and the local version of the data will be used. This is much faster. If you know that some labels have changed in Github, you will want to refresh the data. You can then either delete manually the <chain>.json file or export NO_CACHE=1 to force refreshing the data.

Full PR list

At times, it may be useful to get a raw full PR list. In order to produce this list, you first need to fetch the the latest context.json from the release-notes-context artifacts you can find here. You may store this context.json under scripts/ci/changelog.

Using the full_pr_list.md.tera template, you can generate the raw list of changes:

cd scripts/ci/changelog
tera --env --env-key env  --template templates/full_pr_list.md.tera context.json

2.7 KiB Raw Blame History