Skip to content

Commit 2a5c632

Browse files
committed
changelog cleanup
* removed special treatment for upgrade_information (now a normal list item) * fixed reading "change_type" type url-param in source (requires rebuild of main.js)
1 parent d3f4f6a commit 2a5c632

File tree

6 files changed

+200
-194
lines changed

6 files changed

+200
-194
lines changed

docs/_data/changelog.yml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,9 @@
121121
issues: [SIGN-6856]
122122
self_hosted_installations:
123123
version: 1.189.0
124-
upgrade_information: Additional migration steps happen in final application migration phase. **Expect longer downtime than usual** (exact downtime depends on number of total signing requests and database performance; contact support for details).
125-
# issue: SIGN-7672
124+
upgrade_information:
125+
- text: Additional migration steps happen in final application migration phase. **Expect longer downtime than usual** (exact downtime depends on number of total signing requests and database performance; contact support for details).
126+
issues: [SIGN-7672]
126127
breaking_changes:
127128
- text: |-
128129
`signpath-application` chart: renamed `appSecrets.setupDb.connectionStrings.reportModelDatabaseDdl` to `signingRequestDatabaseDdl` and `appSecrets.shared.connectionStrings.reportModelDatabase` to `signingRequestDatabase`. Note: only the values' _paths_ have changed; keep the values as they are.
@@ -206,7 +207,8 @@
206207
* `GET /SigningRequests/{signingRequestId}/SignedArtifact`
207208
self_hosted_installations:
208209
version: 1.187.0
209-
upgrade_information: Minimum required version to upgrade from is 1.140. In case you have an older version, you first need to upgrade to a previous version (e.g. 1.186, contact support). **[Updated 2025-05-19]**
210+
upgrade_information:
211+
- text: Minimum required version to upgrade from is 1.140. In case you have an older version, you first need to upgrade to a previous version (e.g. 1.186, contact support). **[Updated 2025-05-19]**
210212
# issue: SIGN-7723
211213
improvements:
212214
- text: 'All configuration settings of each container instance are now dumped into a file at startup for easier troubleshooting (except secrets).'
@@ -1641,8 +1643,8 @@
16411643
- text: Support for using mutual TLS client certificates specified by a Microsoft template ID.
16421644
issues: [SIGN-5710]
16431645
self_hosted_installations:
1644-
breaking_changes:
1645-
- text: '_No change required:_ After the upgrade the report model database will be automatically built up from scratch. This means that for a while (depending on the number of signing requests) the signing request list in the UI and the CSV report may be incomplete until the report model building reached the latest signing requests.'
1646+
upgrade_information:
1647+
- text: After the upgrade the report model database will be automatically built up from scratch. This means that for a while (depending on the number of signing requests) the signing request list in the UI and the CSV report may be incomplete until the report model building reached the latest signing requests.
16461648
- date: '2023-04-25'
16471649
updates:
16481650
application:
@@ -2289,7 +2291,8 @@
22892291
issues: [SIGN-4592]
22902292
self_hosted_installations:
22912293
version: 1.106.0
2292-
upgrade_information: The `Configuration.yml` file does not contain settings for the connection strings any more. Connection strings are now handled as secrets by default. However, for migration purposes, the connection strings can still be added to the `Configuration.yml` and referencing secret files is still supported.
2294+
upgrade_information:
2295+
- text: The `Configuration.yml` file does not contain settings for the connection strings any more. Connection strings are now handled as secrets by default. However, for migration purposes, the connection strings can still be added to the `Configuration.yml` and referencing secret files is still supported.
22932296
improvements:
22942297
- text: The secret handling has been unified between the Docker Compose and K8s deployment targets.
22952298
issues: [SIGN-4481]

docs/_data/changelog_components.yml

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/_data/changelog_definitions.yml

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
components:
2+
- id: application
3+
label: 'Application'
4+
categories: [application]
5+
- id: self_hosted_installations
6+
label: 'Application (self-hosted only)'
7+
categories: [application]
8+
- id: powershell_module
9+
label: 'PowerShell Module'
10+
categories: [powershell]
11+
- id: powershell_module_docker
12+
label: 'Docker PowerShell Module'
13+
categories: [powershell]
14+
- id: crypto_providers
15+
label: 'Crypto Providers (Windows, Linux)'
16+
categories: [crypto_providers]
17+
- id: macos_cryptotokenkit
18+
label: 'macOS CryptoTokenKit'
19+
categories: [crypto_providers]
20+
- id: github_connector
21+
label: 'GitHub Connector'
22+
categories: [github, connectors]
23+
- id: github_actions_action
24+
label: 'GitHub Action'
25+
categories: [github, plugins]
26+
- id: jenkins_plugin
27+
label: 'Jenkins Plugin'
28+
categories: [jenkins, plugins]
29+
- id: teamcity_plugin
30+
label: 'TeamCity Plugin'
31+
categories: [teamcity, plugins]
32+
- id: teamcity_connector
33+
label: 'TeamCity Connector'
34+
categories: [teamcity, connectors]
35+
- id: azure_devops_extension
36+
label: 'Azure DevOps Extension'
37+
categories: [azure_devops, plugins]
38+
- id: azure_devops_connector
39+
label: 'Azure DevOps Connector'
40+
categories: [azure_devops, connectors]
41+
- id: scim_connector
42+
label: 'SCIM Connector'
43+
categories: [connectors]
44+
45+
categories:
46+
- id: application
47+
label: Application
48+
- id: powershell
49+
label: PowerShell Modules
50+
- id: connectors
51+
label: Connectors
52+
- id: plugins
53+
label: CI/CD Plugins and Extensions
54+
- id: github
55+
label: GitHub
56+
- id: jenkins
57+
label: Jenkins
58+
- id: teamcity
59+
label: TeamCity
60+
- id: azure_devops
61+
label: Azure DevOps
62+
- id: crypto_providers
63+
label: Crypto Providers
64+
65+
change_types:
66+
- id: all
67+
label: All changes
68+
- id: breaking_changes
69+
label: Breaking changes
70+
- id: upgrade_information
71+
label: Upgrade information
72+
- id: new_features
73+
label: New features
74+
- id: improvements
75+
label: Improvements
76+
- id: changes
77+
label: Changes
78+
- id: bug_fixes
79+
label: Bug fixes

docs/changelog/feeds/changelog_feed.md

Lines changed: 37 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
{%- comment -%}
22
input parameter: "category" (component id)
3+
{%- endcomment -%}
34

4-
---------------- find the last update for the passed in category (or take the latest entry){%- endcomment -%}
5+
{% comment %} find the last update for the specified category (or take the latest entry) {% endcomment %}
56
{%- if include.category -%}
67
{%- assign id = 'https://docs.signpath.io/changelog/feeds/' | append: include.category | append: '.xml' -%}
78
{%- for entry in site.data.changelog -%}
89
{%- if entry.updates -%}
910
{%- for update in entry.updates -%}
1011
{%- if update[0] == include.category -%}
11-
{%- if updated -%}
12-
{%- else -%}
12+
{%- if updated != nil -%}
1313
{%- assign updated = entry.date -%}
1414
{%- endif -%}
1515
{%- endif -%}
@@ -27,7 +27,7 @@
2727
<updated>{{ updated | date: '%F' }}</updated>
2828
<id>{{ id }}</id>
2929
{%- assign category = include.category -%}
30-
{%- assign selected_component = site.data.changelog_components.components | where: "id", category | first -%}
30+
{%- assign selected_component = site.data.changelog_definitions.components | where: "id", category | first -%}
3131
<title type="html">SignPath - {{ selected_component.label }} Changelog</title>
3232
<author>
3333
<name>SignPath GmbH</name>
@@ -37,54 +37,41 @@
3737
{%- if entry.updates -%}
3838
{%- for update in entry.updates -%}
3939
{%- assign componentid = update[0] -%}
40-
{%- assign component = site.data.changelog_components.components | where: "id", componentid | first -%}
40+
{%- assign component = site.data.changelog_definitions.components | where: "id", componentid | first -%}
4141
{%- assign release = update[1] -%}
42-
{%- if include.category == nil or include.category == componentid -%}
43-
<entry>
44-
<id>tag:docs.signpath.io,{{ entry.date | date: '%F'}}:{{ componentid }}:{{ release.version }}</id>
45-
<title>SignPath {{ component.label }} {{ release.version }}</title>
46-
<updated>{{ entry.date | date: '%F' }}</updated>
47-
<published>{{ entry.date | date: '%F' }}</published>
48-
<link rel="alternate" href="https://docs.signpath.io/changelog#{{ entry.date | date: '%F' }}" />
49-
<category term="release/{{ componentid }}" label="{{ component.label }}" />
50-
<summary type="html">New Release: {{ category_label }} {{ release.version }}</summary>
51-
<content type="html">
52-
&lt;div&gt;
53-
&lt;h2&gt;New Release: {{ category_label }} {{ release.version }}&lt;/h2&gt;
54-
{%- for changes_per_type in release -%}
55-
{%- assign change_type = changes_per_type[0] -%}
56-
{%- assign changes = changes_per_type[1] -%}
57-
58-
{%- if change_type != "version" -%}
59-
&lt;h3&gt;
60-
{%- case change_type -%}
61-
{%- when "breaking_changes" -%} Breaking Changes / Manual migration steps:
62-
{%- when "upgrade_information" -%} Upgrade Information:
63-
{%- when "new_features" -%} New Features:
64-
{%- when "improvements" -%} Improvements:
65-
{%- when "changes" -%} Changes:
66-
{%- when "bug_fixes" -%} Bug Fixes:
67-
{%- endcase -%}
68-
&lt;/h3&gt;
69-
{%- if change_type == "upgrade_information" -%}
70-
{{ changes | markdownify | xml_escape }}
71-
{%- else -%}
72-
&lt;ul&gt;
73-
{%- for note in changes -%}
74-
&lt;li&gt;
75-
{{ note.text | markdownify | xml_escape }}
76-
{%- if note.saas_only -%}
77-
&lt;span class='enterprise-only'&gt;(SaaS only)&lt;/span&gt;
78-
{%- endif -%}
79-
&lt;/li&gt;
80-
{%- endfor -%}
81-
&lt;/ul&gt;
42+
{% if include.category == nil or include.category == componentid %}
43+
<entry>
44+
<id>tag:docs.signpath.io,{{ entry.date | date: '%F'}}:{{ componentid }}:{{ release.version }}</id>
45+
<title>SignPath {{ component.label }} {{ release.version }}</title>
46+
<updated>{{ entry.date | date: '%F' }}</updated>
47+
<published>{{ entry.date | date: '%F' }}</published>
48+
<link rel="alternate" href="https://docs.signpath.io/changelog#{{ entry.date | date: '%F' }}" />
49+
<category term="release/{{ componentid }}" label="{{ component.label }}" />
50+
<summary type="html">New Release: {{ category_label }} {{ release.version }}</summary>
51+
<content type="html"> <![CDATA[
52+
<div>
53+
<h2>New Release: {{ category_label }} {{ release.version }}</h2>
54+
{%- for changes_per_type in release -%}
55+
{%- assign change_type = changes_per_type[0] -%}
56+
{%- assign changes = changes_per_type[1] -%}
57+
{%- if change_type != "version" -%}
58+
{% assign type = site.data.changelog_definitions.change_types | where: "id", change_type | first %}
59+
<h3> {{ type.label }}: </h3>
60+
<ul>
61+
{%- for note in changes -%}
62+
<li>
63+
{{ note.text | markdownify }}
64+
{%- if note.saas_only -%}
65+
<span class='enterprise-only'>(SaaS only)</span>
66+
{% endif %}
67+
</li>
68+
{%- endfor -%}
69+
</ul>
8270
{%- endif -%}
83-
{%- endif -%}
84-
{%- endfor -%}
85-
&lt;/div&gt;
86-
</content>
87-
</entry>
71+
{% endfor %}
72+
</div> ]]>
73+
</content>
74+
</entry>
8875
{%- endif -%}
8976
{%- endfor -%}
9077
{%- endif -%}

0 commit comments

Comments
 (0)