mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-13 22:11:06 +00:00
improve wording of release notes (#5513)
* remove verbose 'refs/tags/' from changelog * fix wording in pre_release changelog template * improve migrations wording in changelog template * fixup
This commit is contained in:
@@ -1,26 +1,30 @@
|
|||||||
{%- import "change.md.tera" as m_c %}
|
{%- import "change.md.tera" as m_c %}
|
||||||
{%- set_global db_migration_count = 0 -%}
|
{%- set_global db_migration_count = 0 -%}
|
||||||
|
{%- for pr in changes -%}
|
||||||
|
{%- if pr.meta.B and pr.meta.B.value == 0 %}
|
||||||
|
{#- We skip silent ones -#}
|
||||||
|
{%- elif pr.meta.E and pr.meta.E.value == 2 -%}
|
||||||
|
{%- set_global db_migration_count = db_migration_count + 1 -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endfor -%}
|
||||||
|
|
||||||
## Database Migrations
|
## Database Migrations
|
||||||
|
|
||||||
|
Database migrations are operations upgrading the database to the latest stand.
|
||||||
|
Some migrations may break compatibility, making a backup of your database is highly recommended.
|
||||||
|
|
||||||
|
{% if db_migration_count == 0 -%}
|
||||||
|
ℹ️ There is no database migration in this release.
|
||||||
|
{%- elif db_migration_count == 1 -%}
|
||||||
|
⚠️ There is one database migration in this release:
|
||||||
|
{%- else -%}
|
||||||
|
⚠️ There are {{ db_migration_count }} database migrations in this release:
|
||||||
|
{%- endif %}
|
||||||
{% for pr in changes | sort(attribute="merged_at") -%}
|
{% for pr in changes | sort(attribute="merged_at") -%}
|
||||||
|
|
||||||
{%- if pr.meta.B and pr.meta.B.value == 0 %}
|
{%- if pr.meta.B and pr.meta.B.value == 0 %}
|
||||||
{#- We skip silent ones -#}
|
{#- We skip silent ones -#}
|
||||||
{%- else -%}
|
{%- elif pr.meta.E and pr.meta.E.value == 2 -%}
|
||||||
{%- if pr.meta.E and pr.meta.E.value == 2 -%}
|
|
||||||
{%- set_global db_migration_count = db_migration_count + 1 -%}
|
|
||||||
- {{ m_c::change(c=pr) }}
|
- {{ m_c::change(c=pr) }}
|
||||||
{% endif -%}
|
{% endif -%}
|
||||||
{% endif -%}
|
|
||||||
{% endfor -%}
|
{% endfor -%}
|
||||||
|
|
||||||
{%- if db_migration_count == 0 -%}
|
|
||||||
ℹ️ There is no database migration in this release.
|
|
||||||
{% else %}
|
|
||||||
|
|
||||||
⚠️ There is {{ db_migration_count }} database migration(s) in this release.
|
|
||||||
|
|
||||||
Database migrations are operations bringing your database to the latest stand.
|
|
||||||
Some migrations may break compatibility and making a backup of your database is highly recommended.
|
|
||||||
{%- endif %}
|
|
||||||
|
|||||||
@@ -1,25 +1,29 @@
|
|||||||
{%- import "change.md.tera" as m_c %}
|
{%- import "change.md.tera" as m_c %}
|
||||||
{%- set_global runtime_migration_count = 0 -%}
|
{%- set_global runtime_migration_count = 0 -%}
|
||||||
|
{%- for pr in changes -%}
|
||||||
|
{%- if pr.meta.B and pr.meta.B.value == 0 %}
|
||||||
|
{#- We skip silent ones -#}
|
||||||
|
{%- elif pr.meta.E and pr.meta.E.value == 1 -%}
|
||||||
|
{%- set_global runtime_migration_count = runtime_migration_count + 1 -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endfor -%}
|
||||||
|
|
||||||
## Runtime Migrations
|
## Runtime Migrations
|
||||||
|
|
||||||
|
Runtime migrations are operations running once during a runtime upgrade.
|
||||||
|
|
||||||
|
{% if runtime_migration_count == 0 -%}
|
||||||
|
ℹ️ There is no runtime migration in this release.
|
||||||
|
{%- elif runtime_migration_count == 1 -%}
|
||||||
|
⚠️ There is one runtime migration in this release:
|
||||||
|
{%- else -%}
|
||||||
|
⚠️ There are {{ runtime_migration_count }} runtime migrations in this release:
|
||||||
|
{%- endif %}
|
||||||
{% for pr in changes | sort(attribute="merged_at") -%}
|
{% for pr in changes | sort(attribute="merged_at") -%}
|
||||||
|
|
||||||
{%- if pr.meta.B and pr.meta.B.value == 0 %}
|
{%- if pr.meta.B and pr.meta.B.value == 0 %}
|
||||||
{#- We skip silent ones -#}
|
{#- We skip silent ones -#}
|
||||||
{%- else -%}
|
{%- elif pr.meta.E and pr.meta.E.value == 1 -%}
|
||||||
{%- if pr.meta.E and pr.meta.E.value == 1 -%}
|
|
||||||
{%- set_global runtime_migration_count = runtime_migration_count + 1 -%}
|
|
||||||
- {{ m_c::change(c=pr) }}
|
- {{ m_c::change(c=pr) }}
|
||||||
{% endif -%}
|
{% endif -%}
|
||||||
{% endif -%}
|
|
||||||
{% endfor -%}
|
{% endfor -%}
|
||||||
|
|
||||||
{%- if runtime_migration_count == 0 -%}
|
|
||||||
ℹ️ There is no runtime migration in this release.
|
|
||||||
{% else %}
|
|
||||||
|
|
||||||
⚠️ There is {{ runtime_migration_count }} runtime migration(s) in this release.
|
|
||||||
|
|
||||||
Runtime migrations are operations running once during a runtime upgrade.
|
|
||||||
{%- endif %}
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
{%- if env.PRE_RELEASE == "true" -%}
|
{%- if env.PRE_RELEASE == "true" -%}
|
||||||
<details><summary>⚠️ This is a pre-release</summary>
|
<details><summary>⚠️ This is a pre-release</summary>
|
||||||
|
|
||||||
**Release candidates** are **pre-releases** may not be final.
|
**Release candidates** are **pre-releases** and may not be final.
|
||||||
Although they are reasonably tested, there may be additional changes or issues
|
Although they are reasonably tested, there may be additional changes or issues
|
||||||
before an official release is tagged. Use at your own discretion, and consider
|
before an official release is tagged. Use at your own discretion, and consider
|
||||||
only using final releases on critical production infrastructure.
|
only using final releases on critical production infrastructure.
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
{% if env.PRE_RELEASE == "true" -%}
|
{% if env.PRE_RELEASE == "true" -%}
|
||||||
This pre-release contains the changes from `{{ env.REF1 | replace(from="refs/tags/", to="") }}` to `{{ env.REF2 | replace(from="refs/tags/", to="") }}`.
|
This pre-release contains the changes from `{{ env.REF1 | replace(from="refs/tags/", to="") }}` to `{{ env.REF2 | replace(from="refs/tags/", to="") }}`.
|
||||||
{%- else -%}
|
{%- else -%}
|
||||||
This release contains the changes from `{{ env.REF1 }}` to `{{ env.REF2 }}`.
|
This release contains the changes from `{{ env.REF1 | replace(from="refs/tags/", to="") }}` to `{{ env.REF2 | replace(from="refs/tags/", to="") }}`.
|
||||||
{% endif -%}
|
{% endif -%}
|
||||||
|
|
||||||
{%- set changes = polkadot.changes | concat(with=substrate.changes) -%}
|
{%- set changes = polkadot.changes | concat(with=substrate.changes) -%}
|
||||||
|
|||||||
Reference in New Issue
Block a user