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

New template to generate a full pr list #6692

Merged
merged 1 commit into from
Feb 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions scripts/ci/changelog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,15 @@ By default, if the changelog data from Github is already present, the calls to t
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](https://github.com/paritytech/polkadot/actions/workflows/release-30_publish-draft-release.yml). 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
```
16 changes: 16 additions & 0 deletions scripts/ci/changelog/templates/full_pr_list.md.tera
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{# This is a helper template to get the FULL PR list #}
{# It is not used in the release notes #}

# PR list

## substrate

{%- for change in substrate.changes %}
- [S] [`{{ change.number }}`]({{ change.html_url }}) - {{ change.title }}
{%- endfor %}

## polkadot

{%- for change in polkadot.changes %}
- [P] [`{{ change.number }}`]({{ change.html_url }}) - {{ change.title }}
{%- endfor %}