From f4c6acac9960834fa54267e2647a021b1c82e8f9 Mon Sep 17 00:00:00 2001 From: "Felix Gerbig (Q481981)" Date: Wed, 12 Mar 2025 14:16:12 +0100 Subject: [PATCH 01/10] Initial proposal for TRG 1.09 --- docs/release/trg-1/trg-1-09.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/release/trg-1/trg-1-09.md diff --git a/docs/release/trg-1/trg-1-09.md b/docs/release/trg-1/trg-1-09.md new file mode 100644 index 000000000000..b40e10331e10 --- /dev/null +++ b/docs/release/trg-1/trg-1-09.md @@ -0,0 +1,32 @@ +--- +title: TRG 1.09 - Migration Guide +sidebar_position: 1 +--- + +:::caution +Proposed release date: "mandatory after": 19th of May 2023 +::: + +| Status | Created | Post-History | +|------------|--------------|----------------------------------------| +| Draft | 12-March-2025 | Initial contribution | + +## Why + +Operators and users of a component need a way to understand the impact of a new release on their work. This could be a required database migration, a change in an API call or system behavior. + +Those changes aren't obvious just based on a changelog ([TRG 1.03](https://eclipse-tractusx.github.io/docs/release/trg-1/trg-1-3)) that usually only list all PRs within a release. + +## Description + +A migration guide **must** contain all relevant information for operators of a component to migrate an existing component from the previous to the new version. + +It **must** also contain all relevant changes for users, such as changed API calls, component behaviour, added/deprecated customer facing features etc. + +The migration guide shall _explain_ relevant changes to operators and users. + +## Best Practices + +- A migration guide should be understandable by both operators and users of a component. +- There should be a dedicated migration guide per release: E.g. From 1.1.x -> 1.2.x, 1.2.x -> 2.0.x etc. +- A migration guide should only explain those changes that require an action by operators or users of a component. It should not be a duplication of the changelog. From cd7342db2bd7d7850ccd60b4147ba40796234610 Mon Sep 17 00:00:00 2001 From: Felix Gerbig <48456355+gerbigf@users.noreply.github.com> Date: Thu, 27 Mar 2025 09:40:36 +0100 Subject: [PATCH 02/10] Update docs/release/trg-1/trg-1-09.md sounds good! Co-authored-by: Tom Meyer --- docs/release/trg-1/trg-1-09.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release/trg-1/trg-1-09.md b/docs/release/trg-1/trg-1-09.md index b40e10331e10..efe82bfc2b53 100644 --- a/docs/release/trg-1/trg-1-09.md +++ b/docs/release/trg-1/trg-1-09.md @@ -19,7 +19,7 @@ Those changes aren't obvious just based on a changelog ([TRG 1.03](https://eclip ## Description -A migration guide **must** contain all relevant information for operators of a component to migrate an existing component from the previous to the new version. +A migration guide **must** contain all relevant information for operators of a component to migrate an existing component from the previous to the new version. It must be placed in a directory named `/docs/architecture'. It **must** also contain all relevant changes for users, such as changed API calls, component behaviour, added/deprecated customer facing features etc. From 8254ea708c9ab270810304686ff5346ad0c0e5fe Mon Sep 17 00:00:00 2001 From: Felix Gerbig <48456355+gerbigf@users.noreply.github.com> Date: Thu, 27 Mar 2025 09:41:17 +0100 Subject: [PATCH 03/10] Update docs/release/trg-1/trg-1-09.md Co-authored-by: Lars Geyer-Blaumeiser --- docs/release/trg-1/trg-1-09.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release/trg-1/trg-1-09.md b/docs/release/trg-1/trg-1-09.md index efe82bfc2b53..06901f3af18d 100644 --- a/docs/release/trg-1/trg-1-09.md +++ b/docs/release/trg-1/trg-1-09.md @@ -4,7 +4,7 @@ sidebar_position: 1 --- :::caution -Proposed release date: "mandatory after": 19th of May 2023 +Proposed release date: "mandatory after": tbd ::: | Status | Created | Post-History | From 836cd90af0c3e58fc4c8c0a8da03ff3a4d33e7ff Mon Sep 17 00:00:00 2001 From: Felix Gerbig <48456355+gerbigf@users.noreply.github.com> Date: Mon, 14 Apr 2025 14:12:20 +0200 Subject: [PATCH 04/10] Included @lgblaumeisers proposal Co-authored-by: Lars Geyer-Blaumeiser --- docs/release/trg-1/trg-1-09.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release/trg-1/trg-1-09.md b/docs/release/trg-1/trg-1-09.md index 06901f3af18d..269a7e2b08fc 100644 --- a/docs/release/trg-1/trg-1-09.md +++ b/docs/release/trg-1/trg-1-09.md @@ -27,6 +27,6 @@ The migration guide shall _explain_ relevant changes to operators and users. ## Best Practices -- A migration guide should be understandable by both operators and users of a component. +- A migration guide should support IT operations management and guide the efforts for updating dependent tools and processes. - There should be a dedicated migration guide per release: E.g. From 1.1.x -> 1.2.x, 1.2.x -> 2.0.x etc. - A migration guide should only explain those changes that require an action by operators or users of a component. It should not be a duplication of the changelog. From 73c7b1c0f36321028ae9a8c69d0bf6d8d22783ae Mon Sep 17 00:00:00 2001 From: "Felix Gerbig (Q481981)" Date: Tue, 15 Apr 2025 10:09:28 +0200 Subject: [PATCH 05/10] Included proposals from @evegufy and @lgblaumeiser for wording of IT Operations Management --- .markdownlint.yaml | 3 +-- docs/release/trg-1/trg-1-09.md | 12 ++++++------ 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 66dd7d371a42..10ca6b0c5575 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -23,5 +23,4 @@ # Do not restrict inline HTML: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#MD033 "MD033": false # Allow same content on headlines on siblings: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#MD024 -"MD024": - "siblings_only": true +"MD024": false diff --git a/docs/release/trg-1/trg-1-09.md b/docs/release/trg-1/trg-1-09.md index 269a7e2b08fc..1b0a0ade0394 100644 --- a/docs/release/trg-1/trg-1-09.md +++ b/docs/release/trg-1/trg-1-09.md @@ -13,20 +13,20 @@ Proposed release date: "mandatory after": tbd ## Why -Operators and users of a component need a way to understand the impact of a new release on their work. This could be a required database migration, a change in an API call or system behavior. +IT operations managers and end-users of a component need a way to understand the impact of a new release on their work. This could be a required database migration, a change in an API call or system behavior. Those changes aren't obvious just based on a changelog ([TRG 1.03](https://eclipse-tractusx.github.io/docs/release/trg-1/trg-1-3)) that usually only list all PRs within a release. ## Description -A migration guide **must** contain all relevant information for operators of a component to migrate an existing component from the previous to the new version. It must be placed in a directory named `/docs/architecture'. +A migration guide **must** contain all relevant information for IT operation managers of a component to migrate an existing component from the previous to the new version. It must be placed in a directory named `/docs/admin'. -It **must** also contain all relevant changes for users, such as changed API calls, component behaviour, added/deprecated customer facing features etc. +It **must** also contain all relevant changes for end-users, such as changed API calls, component behaviour, added/deprecated customer facing features etc. -The migration guide shall _explain_ relevant changes to operators and users. +The migration guide shall _explain_ relevant changes to operators and users and not simply list them. ## Best Practices - A migration guide should support IT operations management and guide the efforts for updating dependent tools and processes. -- There should be a dedicated migration guide per release: E.g. From 1.1.x -> 1.2.x, 1.2.x -> 2.0.x etc. -- A migration guide should only explain those changes that require an action by operators or users of a component. It should not be a duplication of the changelog. +- There should be a dedicated migration guide per release that contains relevant changes for IT operations managers or end users : E.g. From 1.1.x -> 1.2.x, 1.2.x -> 2.0.x etc. +- A migration guide should only explain those changes that require an action by IT operations managers or end-users of a component. It should not be a duplication of the changelog. From d6620f646209381b036b0d840139e5153c01c4de Mon Sep 17 00:00:00 2001 From: "Felix Gerbig (Q481981)" Date: Tue, 15 Apr 2025 10:10:57 +0200 Subject: [PATCH 06/10] revert .markdownlint change --- .markdownlint.yaml | 3 ++- docs/release/trg-1/trg-1-09.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 10ca6b0c5575..41416a68e8ed 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -23,4 +23,5 @@ # Do not restrict inline HTML: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#MD033 "MD033": false # Allow same content on headlines on siblings: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#MD024 -"MD024": false +"MD024": + "siblings_only": true \ No newline at end of file diff --git a/docs/release/trg-1/trg-1-09.md b/docs/release/trg-1/trg-1-09.md index 1b0a0ade0394..d4a67e78fac6 100644 --- a/docs/release/trg-1/trg-1-09.md +++ b/docs/release/trg-1/trg-1-09.md @@ -23,7 +23,7 @@ A migration guide **must** contain all relevant information for IT operation man It **must** also contain all relevant changes for end-users, such as changed API calls, component behaviour, added/deprecated customer facing features etc. -The migration guide shall _explain_ relevant changes to operators and users and not simply list them. +The migration guide shall _explain_ relevant changes to operators and users and not simply list them. ## Best Practices From c860f40ef021dfa5374373be2e8bcc639a1aaf68 Mon Sep 17 00:00:00 2001 From: Felix Gerbig <48456355+gerbigf@users.noreply.github.com> Date: Tue, 15 Apr 2025 10:24:11 +0200 Subject: [PATCH 07/10] Update .markdownlint.yaml --- .markdownlint.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 41416a68e8ed..66dd7d371a42 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -24,4 +24,4 @@ "MD033": false # Allow same content on headlines on siblings: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#MD024 "MD024": - "siblings_only": true \ No newline at end of file + "siblings_only": true From b7d38118b83bb4917c835417d30808c4c3db1507 Mon Sep 17 00:00:00 2001 From: "Felix Gerbig (Q481981)" Date: Tue, 15 Apr 2025 10:36:26 +0200 Subject: [PATCH 08/10] Added examples from EDC and Portal --- docs/release/trg-1/trg-1-09.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/release/trg-1/trg-1-09.md b/docs/release/trg-1/trg-1-09.md index d4a67e78fac6..abfb58ca941a 100644 --- a/docs/release/trg-1/trg-1-09.md +++ b/docs/release/trg-1/trg-1-09.md @@ -30,3 +30,7 @@ The migration guide shall _explain_ relevant changes to operators and users and - A migration guide should support IT operations management and guide the efforts for updating dependent tools and processes. - There should be a dedicated migration guide per release that contains relevant changes for IT operations managers or end users : E.g. From 1.1.x -> 1.2.x, 1.2.x -> 2.0.x etc. - A migration guide should only explain those changes that require an action by IT operations managers or end-users of a component. It should not be a duplication of the changelog. + +## Examples +- [Tractus-X EDC migration guide](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/docs/migration) +- [Portal migration guide](https://github.com/eclipse-tractusx/portal-assets/blob/v2.3.0/docs/admin/Version%20Upgrade/portal-upgrade-details.md) From 95d87a436c68851afaea398936897ad0b85e2b45 Mon Sep 17 00:00:00 2001 From: "Felix Gerbig (Q481981)" Date: Tue, 15 Apr 2025 10:53:30 +0200 Subject: [PATCH 09/10] Edited linting --- docs/release/trg-1/trg-1-09.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release/trg-1/trg-1-09.md b/docs/release/trg-1/trg-1-09.md index abfb58ca941a..1f4201df8a82 100644 --- a/docs/release/trg-1/trg-1-09.md +++ b/docs/release/trg-1/trg-1-09.md @@ -32,5 +32,6 @@ The migration guide shall _explain_ relevant changes to operators and users and - A migration guide should only explain those changes that require an action by IT operations managers or end-users of a component. It should not be a duplication of the changelog. ## Examples -- [Tractus-X EDC migration guide](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/docs/migration) + +- [EDC migration guide](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/docs/migration) - [Portal migration guide](https://github.com/eclipse-tractusx/portal-assets/blob/v2.3.0/docs/admin/Version%20Upgrade/portal-upgrade-details.md) From 3c0549555844a9d75ff5c2b46ea1e934ae117976 Mon Sep 17 00:00:00 2001 From: "Felix Gerbig (Q481981)" Date: Wed, 16 Apr 2025 08:42:26 +0200 Subject: [PATCH 10/10] Updated DEPENDENCIES file --- DEPENDENCIES | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEPENDENCIES b/DEPENDENCIES index 0f73e3ae35e1..f74ce8bbfc43 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -312,7 +312,7 @@ npm/npmjs/-/fresh/0.5.2, MIT, approved, clearlydefined npm/npmjs/-/fs-extra/10.1.0, MIT, approved, clearlydefined npm/npmjs/-/fs-extra/9.1.0, MIT, approved, clearlydefined npm/npmjs/-/fs-monkey/1.0.3, Unlicense AND (ISC AND MIT), approved, #2964 -npm/npmjs/-/fs.realpath/1.0.0, ISC, approved, clearlydefined +npm/npmjs/-/fs.realpath/1.0.0, ISC AND MIT, approved, clearlydefined npm/npmjs/-/fsevents/2.3.2, MIT, approved, #2967 npm/npmjs/-/function-bind/1.1.1, MIT, approved, #11063 npm/npmjs/-/gensync/1.0.0-beta.2, MIT, approved, clearlydefined