mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-25 19:57:56 +00:00
Chevdor
42a3afba94
This PR introduces a script and some templates to use the prdoc involved in a release and build: - the changelog - a simple draft of audience documentation Since the prdoc presence was enforced in the middle of the version 1.5.0, not all PRs did come with a `prdoc` file. This PR creates all the missing `prdoc` files with some minimum content allowing to properly generate the changelog. The generated content is **not** suitable for the audience documentation. The audience documentation will be possible with the next version, when all PR come with a proper `prdoc`. ## Assumptions - the prdoc files for release `vX.Y.Z` have been moved under `prdoc/X.Y.Z` - the changelog requires for now for the prdoc files to contain author + topic. Thos fields are optional. The build script can be called as: ``` VERSION=X.Y.Z ./scripts/release/build-changelogs.sh ``` Related: - #1408 --------- Co-authored-by: EgorPopelyaev <egor@parity.io>
8 lines
374 B
Plaintext
8 lines
374 B
Plaintext
## Changelog for `{{ env.PRODUCT | capitalize }} v{{ env.VERSION }}`
|
|
|
|
{% for file in prdoc | sort(attribute="doc_filename.number") -%}
|
|
{%- set author= file.content.author | default(value="n/a") -%}
|
|
{%- set topic= file.content.topic | default(value="n/a") -%}
|
|
- #{{file.doc_filename.number}}: {{ file.content.title }} (@{{ author }}) [{{ topic | capitalize }}]
|
|
{% endfor -%}
|