mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 08:47:57 +00:00
Egor_P
ff906127ab
This PR adds description to each of the sections of the Changelog part. Changes are based on feedback that it wasn't that clear what exactly `Node Dev`, `Runtime Dev` etc. means. Now, the description for each of those parts is taken directly from the `prdoc` schema. Closes https://github.com/paritytech/release-engineering/issues/197
118 lines
6.2 KiB
Bash
Executable File
118 lines
6.2 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
export PRODUCT=polkadot
|
|
export VERSION=${VERSION:-1.5.0}
|
|
export ENGINE=${ENGINE:-podman}
|
|
export REF1=${REF1:-'HEAD'}
|
|
export REF2=${REF2}
|
|
export RUSTC_STABLE=${RUSTC_STABLE:-'1.0'}
|
|
|
|
PROJECT_ROOT=`git rev-parse --show-toplevel`
|
|
echo $PROJECT_ROOT
|
|
|
|
TMP=${TMP:-$(mktemp -d)}
|
|
TEMPLATE_AUDIENCE="${PROJECT_ROOT}/scripts/release/templates/audience.md.tera"
|
|
TEMPLATE_CHANGELOG="${PROJECT_ROOT}/scripts/release/templates/changelog.md.tera"
|
|
|
|
DATA_JSON="${TMP}/data.json"
|
|
CONTEXT_JSON="${TMP}/context.json"
|
|
echo -e "TEMPLATE_AUDIENCE: \t$TEMPLATE_AUDIENCE"
|
|
echo -e "DATA_JSON: \t\t$DATA_JSON"
|
|
echo -e "CONTEXT_JSON: \t\t$CONTEXT_JSON"
|
|
|
|
# Create output folder
|
|
OUTPUT="${TMP}/changelogs/$PRODUCT/$VERSION"
|
|
echo -e "OUTPUT: \t\t$OUTPUT"
|
|
mkdir -p $OUTPUT
|
|
|
|
$ENGINE run --rm -v ${PROJECT_ROOT}:/repo paritytech/prdoc load -d "prdoc/$VERSION" --json > $DATA_JSON
|
|
|
|
cat $DATA_JSON | jq ' { "prdoc" : .}' > $CONTEXT_JSON
|
|
|
|
# Fetch the list of valid audiences and their descriptions
|
|
SCHEMA_URL=https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json
|
|
SCHEMA=$(curl -s $SCHEMA_URL | sed 's|^//.*||')
|
|
aud_desc_array=()
|
|
while IFS= read -r line; do
|
|
audience=$(jq -r '.const' <<< "$line" )
|
|
description=$(jq -r '.description' <<< "$line")
|
|
if [ -n "$audience" ] && [ -n "$description" ]; then
|
|
aud_desc_array+=("($audience; $description)")
|
|
fi
|
|
done < <(jq -c '."$defs".audience_id.oneOf[]' <<< "$SCHEMA")
|
|
|
|
# Generate a release notes doc per audience
|
|
for tuple in "${aud_desc_array[@]}"; do
|
|
audience=$(echo "$tuple" | cut -d ';' -f 1 | sed 's/(//')
|
|
audience_id="$(tr [A-Z] [a-z] <<< "$audience")"
|
|
audience_id="$(tr ' ' '_' <<< "$audience_id")"
|
|
|
|
description=$(echo "$tuple" | cut -d ';' -f 2 | sed 's/)//')
|
|
|
|
echo "Processing audience: $audience ($audience_id)"
|
|
export TARGET_AUDIENCE="$audience"
|
|
export AUDIENCE_DESC="**These changes are relevant to:** $description"
|
|
|
|
tera -t "${TEMPLATE_AUDIENCE}" --env --env-key env "${CONTEXT_JSON}" > "$OUTPUT/relnote_${audience_id}.md"
|
|
cat "$OUTPUT/relnote_${audience_id}.md" >> "$PROJECT_ROOT/scripts/release/templates/changelog.md"
|
|
done
|
|
|
|
|
|
# Generate a changelog containing list of the commits
|
|
echo "Generating changelog..."
|
|
tera -t "${TEMPLATE_CHANGELOG}" --env --env-key env "${CONTEXT_JSON}" > "$OUTPUT/relnote_commits.md"
|
|
echo "Changelog ready in $OUTPUT/relnote_commits.md"
|
|
|
|
# Show the files
|
|
tree -s -h -c $OUTPUT/
|
|
|
|
ASSET_HUB_ROCOCO_DIGEST=${ASSET_HUB_ROCOCO_DIGEST:-"$PROJECT_ROOT/scripts/release/digests/asset-hub-rococo-srtool-digest.json"}
|
|
ASSET_HUB_WESTEND_DIGEST=${ASSET_HUB_WESTEND_DIGEST:-"$PROJECT_ROOT/scripts/release/digests/asset-hub-westend-srtool-digest.json"}
|
|
BRIDGE_HUB_ROCOCO_DIGEST=${BRIDGE_HUB_ROCOCO_DIGEST:-"$PROJECT_ROOT/scripts/release/digests/bridge-hub-rococo-srtool-digest.json"}
|
|
BRIDGE_HUB_WESTEND_DIGEST=${BRIDGE_HUB_WESTEND_DIGEST:-"$PROJECT_ROOT/scripts/release/digests/bridge-hub-westend-srtool-digest.json"}
|
|
COLLECTIVES_WESTEND_DIGEST=${COLLECTIVES_WESTEND_DIGEST:-"$PROJECT_ROOT/scripts/release/digests/collectives-westend-srtool-digest.json"}
|
|
CONTRACTS_ROCOCO_DIGEST=${CONTRACTS_ROCOCO_DIGEST:-"$PROJECT_ROOT/scripts/release/digests/contracts-rococo-srtool-digest.json"}
|
|
CORETIME_ROCOCO_DIGEST=${CORETIME_ROCOCO_DIGEST:-"$PROJECT_ROOT/scripts/release/digests/coretime-rococo-srtool-digest.json"}
|
|
CORETIME_WESTEND_DIGEST=${CORETIME_WESTEND_DIGEST:-"$PROJECT_ROOT/scripts/release/digests/coretime-westend-srtool-digest.json"}
|
|
GLUTTON_WESTEND_DIGEST=${GLUTTON_WESTEND_DIGEST:-"$PROJECT_ROOT/scripts/release/digests/glutton-westend-srtool-digest.json"}
|
|
PEOPLE_ROCOCO_DIGEST=${PEOPLE_ROCOCO_DIGEST:-"$PROJECT_ROOT/scripts/release/digests/people-rococo-srtool-digest.json"}
|
|
PEOPLE_WESTEND_DIGEST=${PEOPLE_WESTEND_DIGEST:-"$PROJECT_ROOT/scripts/release/digests/people-westend-srtool-digest.json"}
|
|
ROCOCO_DIGEST=${ROCOCO_DIGEST:-"$PROJECT_ROOT/scripts/release/digests/rococo-srtool-digest.json"}
|
|
WESTEND_DIGEST=${WESTEND_DIGEST:-"$PROJECT_ROOT/scripts/release/digests/westend-srtool-digest.json"}
|
|
|
|
jq \
|
|
--slurpfile srtool_asset_hub_rococo $ASSET_HUB_ROCOCO_DIGEST \
|
|
--slurpfile srtool_asset_hub_westend $ASSET_HUB_WESTEND_DIGEST \
|
|
--slurpfile srtool_bridge_hub_rococo $BRIDGE_HUB_ROCOCO_DIGEST \
|
|
--slurpfile srtool_bridge_hub_westend $BRIDGE_HUB_WESTEND_DIGEST \
|
|
--slurpfile srtool_collectives_westend $COLLECTIVES_WESTEND_DIGEST \
|
|
--slurpfile srtool_contracts_rococo $CONTRACTS_ROCOCO_DIGEST \
|
|
--slurpfile srtool_coretime_rococo $CORETIME_ROCOCO_DIGEST\
|
|
--slurpfile srtool_coretime_westend $CORETIME_WESTEND_DIGEST \
|
|
--slurpfile srtool_glutton_westend $GLUTTON_WESTEND_DIGEST \
|
|
--slurpfile srtool_people_rococ $PEOPLE_ROCOCO_DIGEST \
|
|
--slurpfile srtool_people_westend $PEOPLE_WESTEND_DIGEST \
|
|
--slurpfile srtool_rococo $ROCOCO_DIGEST \
|
|
--slurpfile srtool_westend $WESTEND_DIGEST \
|
|
-n '{
|
|
srtool: [
|
|
{ order: 10, name: "Westend", data: $srtool_westend[0] },
|
|
{ order: 11, name: "Westend AssetHub", data: $srtool_asset_hub_westend[0] },
|
|
{ order: 12, name: "Westend BridgeHub", data: $srtool_bridge_hub_westend[0] },
|
|
{ order: 13, name: "Westend Collectives", data: $srtool_collectives_westend[0] },
|
|
{ order: 14, name: "Westend Coretime", data: $srtool_coretime_westend[0] },
|
|
{ order: 15, name: "Westend Glutton", data: $srtool_glutton_westend[0] },
|
|
{ order: 16, name: "Westend People", data: $srtool_people_westend[0] },
|
|
{ order: 17, name: "Rococo", data: $srtool_rococo[0] },
|
|
{ order: 18, name: "Rococo AssetHub", data: $srtool_asset_hub_rococo[0] },
|
|
{ order: 19, name: "Rococo BridgeHub", data: $srtool_bridge_hub_rococo[0] },
|
|
{ order: 20, name: "Rococo Contracts", data: $srtool_contracts_rococo[0] },
|
|
{ order: 21, name: "Rococo Coretime", data: $srtool_coretime_rococo[0] },
|
|
{ order: 22, name: "Rococo People", data: $srtool_people_rococ[0] }
|
|
] }' > "$PROJECT_ROOT/scripts/release/context.json"
|
|
|
|
RELEASE_DIR="$PROJECT_ROOT/scripts/release/"
|
|
pushd $RELEASE_DIR >/dev/null
|
|
tera --env --env-key env --include-path templates --template templates/template.md.tera context.json > RELEASE_DRAFT.md
|
|
popd >/dev/null
|