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:
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
@@ -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 %}