Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Commit

Permalink
Update release-related templates for the new changelogerator output f…
Browse files Browse the repository at this point in the history
…ormat (#6702) (#6731)

* update templates to upcoming context.json format

* fix merging error

* more fixes

* fix templates

* fix

* print "changelogerator --version"

* print changelogerator version as debug

* remove excluded debug info

* WIP

* Switch to changelogerator v0.10.1

* Update bundle deps

* fix

---------

Co-authored-by: JP <77391175+joao-paulo-parity@users.noreply.github.com>
  • Loading branch information
chevdor and joao-paulo-parity authored Feb 16, 2023
1 parent 909567f commit 72309a2
Show file tree
Hide file tree
Showing 13 changed files with 37 additions and 40 deletions.
2 changes: 1 addition & 1 deletion scripts/ci/changelog/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ gem 'optparse', '~> 0.1.1'

gem 'logger', '~> 1.4'

gem 'changelogerator', '0.9.1'
gem 'changelogerator', '0.10.1'

gem 'test-unit', group: :dev

Expand Down
4 changes: 2 additions & 2 deletions scripts/ci/changelog/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ GEM
addressable (2.8.0)
public_suffix (>= 2.0.2, < 5.0)
ast (2.4.2)
changelogerator (0.9.1)
changelogerator (0.10.1)
git_diff_parser (~> 3)
octokit (~> 4)
faraday (1.8.0)
Expand Down Expand Up @@ -70,7 +70,7 @@ PLATFORMS
x86_64-darwin-22

DEPENDENCIES
changelogerator (= 0.9.1)
changelogerator (= 0.10.1)
git_diff_parser (~> 3)
logger (~> 1.4)
octokit (~> 4)
Expand Down
3 changes: 3 additions & 0 deletions scripts/ci/changelog/bin/changelog
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ logger = Logger.new($stdout)
logger.level = Logger::DEBUG
logger.debug('Starting')

changelogerator_version = `changelogerator --version`
logger.debug(changelogerator_version)

owner = 'paritytech'
repo = 'polkadot'

Expand Down
16 changes: 8 additions & 8 deletions scripts/ci/changelog/templates/change.md.tera
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
{# This macro shows ONE change #}
{%- macro change(c, cml="[C]", dot="[P]", sub="[S]") -%}

{%- if c.meta.C and c.meta.C.value >= 7 -%}
{%- if c.meta.C and c.meta.C.agg.max >= 7 -%}
{%- set prio = " ‼️ HIGH" -%}
{%- elif c.meta.C and c.meta.C.value >= 3 -%}
{%- elif c.meta.C and c.meta.C.agg.max >= 3 -%}
{%- set prio = " ❗️ Medium" -%}
{%- elif c.meta.C and c.meta.C.value < 3 -%}
{%- elif c.meta.C and c.meta.C.agg.max < 3 -%}
{%- set prio = " Low" -%}
{%- else -%}
{%- set prio = "" -%}
{%- endif -%}

{%- set audit = "" -%}

{%- if c.meta.D and c.meta.D.value == 1 -%}
{%- if c.meta.D and c.meta.D.D1 -%}
{%- set audit = "✅ audited " -%}
{%- elif c.meta.D and c.meta.D.value == 2 -%}
{%- elif c.meta.D and c.meta.D.D2 -%}
{%- set audit = "✅ trivial " -%}
{%- elif c.meta.D and c.meta.D.value == 3 -%}
{%- elif c.meta.D and c.meta.D.D3 -%}
{%- set audit = "✅ trivial " -%}
{%- elif c.meta.D and c.meta.D.value == 5 -%}
{%- elif c.meta.D and c.meta.D.D5 -%}
{%- set audit = "⏳ pending non-critical audit " -%}
{%- else -%}
{%- set audit = "" -%}
Expand All @@ -33,7 +33,7 @@
{%- set repo = " " -%}
{%- endif -%}

{%- if c.meta.T and c.meta.T.value == 6 -%}
{%- if c.meta.T and c.meta.T.T6 -%}
{%- set xcm = " [✉️ XCM]" -%}
{%- else -%}
{%- set xcm = "" -%}
Expand Down
6 changes: 2 additions & 4 deletions scripts/ci/changelog/templates/changes_api.md.tera
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@
{%- for pr in changes | sort(attribute="merged_at") %}

{%- if pr.meta.B %}
{%- if pr.meta.B.value == 0 %}
{%- if pr.meta.B.B0 %}
{#- We skip silent ones -#}
{%- else -%}

{%- if pr.meta.T and pr.meta.T.value == 2 and not pr.title is containing("ompanion") %}
{%- if pr.meta.T and pr.meta.T.T2 and not pr.title is containing("ompanion") %}
- {{ m_c::change(c=pr) }}
{%- else %}
<!-- EXCLUDED PR#{{pr.number}} - {{pr.html_url}} -->
{%- endif -%}
{% endif -%}
{% endif -%}
Expand Down
6 changes: 2 additions & 4 deletions scripts/ci/changelog/templates/changes_client.md.tera
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@
{%- for pr in changes | sort(attribute="merged_at") %}

{%- if pr.meta.B %}
{%- if pr.meta.B.value == 0 %}
{%- if pr.meta.B.B0 %}
{#- We skip silent ones -#}
{%- else -%}

{%- if pr.meta.T and pr.meta.T.value == 0 and not pr.title is containing("ompanion") %}
{%- if pr.meta.T and pr.meta.T.T0 and not pr.title is containing("ompanion") %}
- {{ m_c::change(c=pr) }}
{%- else %}
<!-- EXCLUDED PR#{{pr.number}} - {{pr.html_url}} -->
{%- endif -%}
{% endif -%}
{% endif -%}
Expand Down
8 changes: 4 additions & 4 deletions scripts/ci/changelog/templates/changes_misc.md.tera
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
{#- First pass to count #}
{%- for pr in changes -%}
{%- if pr.meta.B %}
{%- if pr.meta.B.value == 0 -%}
{%- if pr.meta.B.B0 -%}
{#- We skip silent ones -#}
{%- else -%}
{%- if pr.meta.T and pr.meta.T.value > 2 %}
{%- if pr.meta.T and pr.meta.T.agg.max > 2 %}
{%- set_global misc_count = misc_count + 1 -%}
{%- endif -%}
{% endif -%}
Expand All @@ -26,10 +26,10 @@ There are other misc. changes. You can expand the list below to view them all.
{#- The changes are sorted by merge date #}
{%- for pr in changes | sort(attribute="merged_at") %}
{%- if pr.meta.B and not pr.title is containing("ompanion") %}
{%- if pr.meta.B.value == 0 %}
{%- if pr.meta.B.B0 %}
{#- We skip silent ones -#}
{%- else -%}
{%- if pr.meta.T and pr.meta.T.value > 2 %}
{%- if pr.meta.T and pr.meta.T.agg.max > 2 %}
- {{ m_c::change(c=pr) }}
{%- endif -%}
{% endif -%}
Expand Down
6 changes: 2 additions & 4 deletions scripts/ci/changelog/templates/changes_runtime.md.tera
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,12 @@
{% for pr in changes | sort(attribute="merged_at") -%}

{%- if pr.meta.B -%}
{%- if pr.meta.B.value == 0 -%}
{%- if pr.meta.B.B0 -%}
{#- We skip silent ones -#}
{%- else -%}

{%- if pr.meta.T and pr.meta.T.value == 1 and not pr.title is containing("ompanion") %}
{%- if pr.meta.T and pr.meta.T.T1 and not pr.title is containing("ompanion") %}
- {{ m_c::change(c=pr) }}
{%- else %}
<!-- EXCLUDED PR#{{pr.number}} - {{pr.html_url}} -->
{%- endif -%}
{%- endif -%}

Expand Down
2 changes: 1 addition & 1 deletion scripts/ci/changelog/templates/debug.md.tera
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{%- set to_ignore = changes | filter(attribute="meta.B.value", value=0) %}
{%- set to_ignore = changes | filter(attribute="meta.B.B0") %}

<!--
changes:
Expand Down
4 changes: 2 additions & 2 deletions scripts/ci/changelog/templates/high_priority.md.tera
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
The changes motivating this priority level are:
{% for pr in changes | sort(attribute="merged_at") -%}
{%- if pr.meta.C -%}
{%- if pr.meta.C.value == p %}
{%- if pr.meta.C.agg.max >= p %}
- {{ m_c::change(c=pr) }}
{%- if pr.meta.T and pr.meta.T.value == 1 %} (RUNTIME)
{%- if pr.meta.T and pr.meta.T.T1 %} (RUNTIME)
{% endif %}
{%- endif -%}
{%- endif -%}
Expand Down
4 changes: 2 additions & 2 deletions scripts/ci/changelog/templates/host_functions.md.tera
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@

{% 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.B0 -%}
{#- We skip silent ones -#}
{%- else -%}
{%- if pr.meta.E and pr.meta.E.value == 4 -%}
{%- if pr.meta.E and pr.meta.E.E4 -%}
{%- set_global host_fn_count = host_fn_count + 1 -%}
- {{ m_c::change(c=pr) }}
{% endif -%}
Expand Down
8 changes: 4 additions & 4 deletions scripts/ci/changelog/templates/migrations-db.md.tera
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{% 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 %}
{%- if pr.meta.B and pr.meta.B.B0 %}
{#- We skip silent ones -#}
{%- elif pr.meta.E and pr.meta.E.value == 2 -%}
{%- elif pr.meta.E and pr.meta.E.E2 -%}
{%- set_global db_migration_count = db_migration_count + 1 -%}
{%- endif -%}
{%- endfor %}
Expand All @@ -22,9 +22,9 @@ Some migrations may break compatibility, making a backup of your database is hig
{%- endif %}
{% 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.B0 %}
{#- We skip silent ones -#}
{%- elif pr.meta.E and pr.meta.E.value == 2 -%}
{%- elif pr.meta.E and pr.meta.E.E2 -%}
- {{ m_c::change(c=pr) }}
{% endif -%}
{% endfor -%}
8 changes: 4 additions & 4 deletions scripts/ci/changelog/templates/migrations-runtime.md.tera
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{%- 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 %}
{%- if pr.meta.B and pr.meta.B.B0 %}
{#- We skip silent ones -#}
{%- elif pr.meta.E and pr.meta.E.value == 1 -%}
{%- elif pr.meta.E and pr.meta.E.E1 -%}
{%- set_global runtime_migration_count = runtime_migration_count + 1 -%}
{%- endif -%}
{%- endfor %}
Expand All @@ -21,9 +21,9 @@ Runtime migrations are operations running once during a runtime upgrade.
{%- endif %}
{% 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.B0 %}
{#- We skip silent ones -#}
{%- elif pr.meta.E and pr.meta.E.value == 1 -%}
{%- elif pr.meta.E and pr.meta.E.E1 -%}
- {{ m_c::change(c=pr) }}
{% endif -%}
{% endfor -%}

0 comments on commit 72309a2

Please sign in to comment.