Changelogs local generation (#1411)

mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-05-31 05:11:02 +00:00

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>

This commit is contained in:

Chevdor

2023-12-12 15:29:56 +01:00

committed by

GitHub

parent 6b5995ffd1

commit 42a3afba94

98 changed files with 643 additions and 27 deletions

									
										cumulus/polkadot-parachain/Cargo.toml
									
		+1
		-1
	
												View File
												
				@@ -1,6 +1,6 @@

				[package]

				name = "polkadot-parachain-bin"

				version = "1.1.0"

				version = "1.5.0"

				authors.workspace = true

				build = "build.rs"

				edition.workspace = true