pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-04-28 23:47:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

improve wording of release notes (#5513)

Browse Source 
* 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:
Mara Robin B
2022-05-12 15:56:33 +02:00
committed by GitHub
parent 2bb89cc5c9
commit 9fb96a7d2f
4 changed files with 37 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
polkadot/scripts/ci/changelog/templates/migrations-db.md.tera
+18 -14
View File
@@ -1,26 +1,30 @@
{%- import "change.md.tera" as m_c %}
{%- 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 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") -%}
{%- if pr.meta.B and pr.meta.B.value == 0 %}
{#- We skip silent ones -#}
{%- else -%}
{%- if pr.meta.E and pr.meta.E.value == 2 -%}
{%- set_global db_migration_count = db_migration_count + 1 -%}
{%- elif pr.meta.E and pr.meta.E.value == 2 -%}
- {{ m_c::change(c=pr) }}
{% endif -%}
{% endif -%}
{% 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 %}
polkadot/scripts/ci/changelog/templates/migrations-runtime.md.tera
+17 -13
View File
@@ -1,25 +1,29 @@
{%- import "change.md.tera" as m_c %}
{%- 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 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") -%}
{%- if pr.meta.B and pr.meta.B.value == 0 %}
{#- We skip silent ones -#}
{%- else -%}
{%- if pr.meta.E and pr.meta.E.value == 1 -%}
{%- set_global runtime_migration_count = runtime_migration_count + 1 -%}
{%- elif pr.meta.E and pr.meta.E.value == 1 -%}
- {{ m_c::change(c=pr) }}
{% endif -%}
{% endif -%}
{% 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 %}
polkadot/scripts/ci/changelog/templates/pre_release.md.tera
+1 -1
View File
@@ -1,7 +1,7 @@
{%- if env.PRE_RELEASE == "true" -%}
<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
before an official release is tagged. Use at your own discretion, and consider
only using final releases on critical production infrastructure.
polkadot/scripts/ci/changelog/templates/template.md.tera
+1 -1
View File
@@ -5,7 +5,7 @@
{% 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="") }}`.
{%- 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 -%}
{%- set changes = polkadot.changes | concat(with=substrate.changes) -%}