Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Create release draft workflow + templates for the free notes and docker images sections in the notes #4371

Merged
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
1 change: 1 addition & 0 deletions .github/workflows/release-30_publish_release_draft.yml
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ jobs:
post_to_matrix:
runs-on: ubuntu-latest
needs: publish-release-draft
environment: release
strategy:
matrix:
channel:
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/release-99_notif-published.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,3 @@ jobs:
Release version: [${{github.event.release.tag_name}}](${{github.event.release.html_url}})

-----

${{github.event.release.body}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So there is a link to the full notes instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So there is a link to the full notes instead?

Yep, otherwise it might fail like after the last release, because the message was too large for the Element

2 changes: 1 addition & 1 deletion scripts/release/build-changelogs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ for tuple in "${aud_desc_array[@]}"; do

echo "Processing audience: $audience ($audience_id)"
export TARGET_AUDIENCE="$audience"
export AUDIENCE_DESC="**These changes are relevant to:** $description"
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"
Expand Down
10 changes: 10 additions & 0 deletions scripts/release/templates/_free_notes.md.tera
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

{# This file uses the Markdown format with additional templating such as this comment. -#}
{# Such a comment will not show up in the rendered release notes. -#}
{# The content of this file (if any) will be inserted at the top of the release notes -#}
{# and generated for each new release candidate. -#}
{# Ensure you leave an empty line at both top and bottom of this file. -#}

<!-- Such a comment will be rendered but remain invisible in the rendered markdown -->
<!-- Edit below this line -->
<!-- Edit above this line -->
19 changes: 19 additions & 0 deletions scripts/release/templates/docker_image.md.tera
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

## Docker images

The docker images for the `polkadot` node binary and the `polkadot-parachain` binary can be found at Docker hub (will be available a few minutes after the release has been published):
- [Polkadot image](https://hub.docker.com/r/parity/polkadot/tags?page=1&ordering=last_updated)
- [Polkadot-Parachain image](https://hub.docker.com/r/parity/polkadot-parachain/tags?page=1&ordering=last_updated)


You may also pull it with:

```
docker pull parity/polkadot:latest
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: the hash could be in here to ensure that they pull the released version.

```

or

```
docker pull parity/polkadot-parachain:latest
```
6 changes: 6 additions & 0 deletions scripts/release/templates/template.md.tera
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,14 @@

This release contains the changes from `{{ env.REF1 | replace(from="refs/tags/", to="") }}` to `{{ env.REF2 | replace(from="refs/tags/", to="") }}`.

{# -- Manual free notes section -- #}
{% include "_free_notes.md.tera" -%}

{# -- Automatic section -- #}
{% include "changes.md.tera" -%}

{% include "compiler.md.tera" -%}

{% include "runtimes.md.tera" -%}

{% include "docker_image.md.tera" -%}