mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-25 23:27:56 +00:00
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>
28 lines
873 B
Plaintext
28 lines
873 B
Plaintext
# Schema: Parity PR Documentation Schema (prdoc)
|
|
# See doc at https://github.com/paritytech/prdoc
|
|
|
|
title: Different builder pattern constructors for XCM
|
|
|
|
author: franciscoaguirre
|
|
topic: runtime
|
|
|
|
doc:
|
|
- audience: Runtime Dev
|
|
description: |
|
|
The `builder()` constructor for XCM programs now only allows building messages that pay for fees,
|
|
i.e. messages that would pass the `AllowTopLevelPaidExecutionFrom` barrier.
|
|
Another constructor, `builder_unpaid()` requires an explicit `UnpaidExecution` instruction before
|
|
anything else.
|
|
For building messages without any restriction, `builder_unsafe` can be used.
|
|
This has been named like that since in general the other two should be used instead, but it's okay
|
|
to use it for teaching purposes or for experimenting.
|
|
|
|
migrations:
|
|
db: []
|
|
|
|
runtime: []
|
|
|
|
crates: []
|
|
|
|
host_functions: []
|