Skip to content

docs(internet-header): add a warning that the v10 Internet Header requires requesting a new config #8355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
alionazherdetska wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs(internet-header): add a warning that the v10 Internet Header requires requesting a new config #8355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
520bcb1
docs(internet-header): add warning banner about v10 Portal configurat…
alionazherdetska Aug 21, 2026
dde000e
added an extra space
alionazherdetska Aug 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/three-bubbles-there.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@swisspost/design-system-documentation': patch
---

Added a warning that the `v10` Internet Header requires requesting a new Portal configuration and will not work with the old `v9` format.
41 changes: 41 additions & 0 deletions apps/documentation/src/stories/misc/migration-guide/migrationv9-10.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ export class MigrationV910Component extends LitElement {
tag: false,
},
internet_header: {
request_config: false,
update_package: false,
add_text_props: false,
remove_props: false,
Expand Down Expand Up @@ -1447,7 +1448,47 @@ export class MyComponent {
? html`
<section>
<h4>Internet Header (@swisspost/internet-header)</h4>
<post-banner type="warning" class="mb-16">
<p>
Version 10 uses a <strong>new configuration format</strong>. Your
existing v9 Portal configuration will not work with the v10 Internet
Header and will cause errors at runtime. You must request a
configuration migration <strong>before</strong> upgrading the package.
</p>
</post-banner>
<ul class="list-unstyled">
<li class="mb-16">
<div class="form-check">
<input
id="internet_header-request_config"
class="form-check-input"
type="checkbox"
?checked="${this.state.internet_header.request_config}"
/>
<label class="form-check-label" for="internet_header-request_config">
Request a configuration migration to the v10 format
<span class="info">
<p>
The v10 Internet Header uses a new Portal configuration format.
Your existing v9 configuration is incompatible and will cause
runtime errors after upgrading.
</p>
<p>
Contact the Post Portal Team at
<a href="mailto:dm-tec@post.ch">dm-tec@post.ch</a> to request a
configuration migration. Provide your
<code>serviceId</code> (project ID) and the environments you
need migrated (e.g. <code>int01</code>, <code>int02</code>,
<code>prod</code>).
</p>
<p>
Do not upgrade the <code>@swisspost/internet-header</code>
package until the new configuration is in place.
</p>
</span>
</label>
</div>
</li>
<li class="mb-16">
<div class="form-check">
<input
Expand Down
13 changes: 13 additions & 0 deletions apps/documentation/src/stories/packages/internet-header/internet-header.docs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,19 @@ import { PackageShields } from '@root/src/shared/package-shields';
<p>The Internet Header is built to support the already existing Portal Configuration used for the old Internet Header.
<br/>If you're working on a new project, you probably need a new configuration. Please contact the Post Portal Team.</p>

<post-banner type="warning" className="mt-16 mb-16">
<h4 slot="heading">Migrating from v9?</h4>
<p>
Version 10 uses a <strong>new configuration format</strong>. Your existing v9
configuration <strong>will not work</strong> with the v10 header and will cause
errors at runtime. Before upgrading, contact the Post Portal Team at{' '}
<a href="mailto:dm-tec@post.ch" rel="noopener">dm-tec@post.ch <post-icon name="letter" /></a>{' '}
to request a <strong>configuration migration</strong> to the v10 format. Provide your
project's <code>serviceId</code> and the environments you need migrated
(e.g. <code>int01</code>, <code>int02</code>, <code>prod</code>).
</p>
</post-banner>

<h3>Step 1</h3>
<p>Integration of header only: contact <a href="mailto:dm-tec@post.ch" rel="noopener">dm-tec@post.ch <post-icon name="letter" /></a> directly</p>
<p>Integration of header and KLP: contact KLP first for integration</p>
Expand Down
Loading