Added initial release management process description. #578

FScholPer · 2025-03-06T09:03:48Z

…areas index.rst to point to new release_management process. Moved workproducts from general area to new release_management process

Frank Scholter Peres [email protected], Daniel Kroehnert[email protected] Mercedes-Benz Tech Innovation GmbH
Provider Information

github-actions · 2025-03-06T09:04:50Z

License Check Results

🚀 The license check preparation job ran successfully.

Status: ⚠️ Needs Review

Click to expand output

2025/03/12 16:58:16 Downloading https://releases.bazel.build/7.4.0/release/bazel-7.4.0-linux-x86_64...
Extracting Bazel installation...
Starting local Bazel server and connecting to it...
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: docs
Loading: 0 packages loaded
    currently loading: docs
Analyzing: target //docs:license.check.python (1 packages loaded)
Analyzing: target //docs:license.check.python (1 packages loaded, 0 targets configured)
Analyzing: target //docs:license.check.python (1 packages loaded, 0 targets configured)

Analyzing: target //docs:license.check.python (97 packages loaded, 10 targets configured)

Analyzing: target //docs:license.check.python (127 packages loaded, 803 targets configured)

Analyzing: target //docs:license.check.python (136 packages loaded, 1226 targets configured)

Analyzing: target //docs:license.check.python (144 packages loaded, 2465 targets configured)

Analyzing: target //docs:license.check.python (144 packages loaded, 2465 targets configured)

Analyzing: target //docs:license.check.python (147 packages loaded, 4487 targets configured)

Analyzing: target //docs:license.check.python (148 packages loaded, 4611 targets configured)

Analyzing: target //docs:license.check.python (148 packages loaded, 4611 targets configured)

Analyzing: target //docs:license.check.python (148 packages loaded, 4611 targets configured)

INFO: Analyzed target //docs:license.check.python (149 packages loaded, 4736 targets configured).
[11 / 13] [Prepa] JavaToolchainCompileBootClasspath external/rules_java~/toolchains/platformclasspath.jar
[12 / 13] Building docs/license.check.python.jar (); 0s multiplex-worker
INFO: Found 1 target...
Target //docs:license.check.python up-to-date:
  bazel-bin/docs/license.check.python
  bazel-bin/docs/license.check.python.jar
INFO: Elapsed time: 21.069s, Critical Path: 2.50s
INFO: 13 processes: 9 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/docs/license.check.python docs/formatted.txt -review -project automotive.score -repo https://github.com/eclipse-score/score -token otyhZ4eaRYK1tKLNNF-Y
[main] INFO Querying Eclipse Foundation for license data for 69 items.
[main] INFO Found 45 items.
[main] INFO Querying ClearlyDefined for license data for 31 items.
[main] INFO Found 31 items.
[main] INFO License information could not be automatically verified for the following content:
[main] INFO 
[main] INFO pypi/pypi/-/debugpy/1.8.12
[main] INFO pypi/pypi/-/docutils/0.21.2
[main] INFO pypi/pypi/-/fonttools/4.56.0
[main] INFO pypi/pypi/-/matplotlib/3.10.0
[main] INFO pypi/pypi/-/numpy/2.2.3
[main] INFO pypi/pypi/-/pillow/11.1.0
[main] INFO pypi/pypi/-/pyparsing/3.2.1
[main] INFO 
[main] INFO This content is either not correctly mapped by the system, or requires review.
[main] INFO A review is required for pypi/pypi/-/numpy/2.2.3.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19888 .
[main] INFO A review is required for pypi/pypi/-/fonttools/4.56.0.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19889 .
[main] INFO A review is required for pypi/pypi/-/docutils/0.21.2.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19880 .
[main] INFO A review is required for pypi/pypi/-/pillow/11.1.0.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19890 .
[main] INFO A review is required for pypi/pypi/-/pyparsing/3.2.1.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19891 .
[main] INFO A review is required for pypi/pypi/-/debugpy/1.8.12.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19903 .
[main] INFO A review is required for pypi/pypi/-/matplotlib/3.10.0.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19892 .

github-actions · 2025-03-06T09:06:10Z

The created documentation from the pull request is available at: docu-html

masc2023 · 2025-03-07T06:54:23Z

@kroehnd , I am not able to build that locally, as branch is not reachable for me

Added initial release managmenet process description. Edited process_areas index.rst to point to new release_management process. Moved workproducts from general area to new release_management process Fixed gitlint issues, added missing Copyright header. Resolves: eclipse-score#313

…cess

hoe-jo · 2025-03-10T06:57:12Z

docs/process/process_areas/release_management/release_concept.rst

+The release process can be separated into two parts. On the first level are the software module
+releases. These are independent from the platform and can be separated over various repositories.
+Once a software module is released it can be contained within a platform release which
+can include multiple software module releases within a platform release scope.


Different modules? But still the same version of one module for whole platform?

Multiple software modules refers to different modules. Yes, it is meant that only one version of a sw module at a time can be used.

Proposal for change:
Once a software module is released it can be contained within a platform release which
can include multiple software module within a platform release scope.

hoe-jo · 2025-03-10T06:59:19Z

docs/process/process_areas/release_management/release_concept.rst

+   * Creates and maintains the platform release plan
+   * Aligns with the *Tech Lead Circle* the timeline from various module release plans
+
+Platform Release


What do you mean by platform release? Release of the score repository or the reference integration?

Also what is the git branching strategy? Will we have an separate Release Branch for Platform and all Modules?

What do you mean by platform release? Release of the score repository or the reference integration?

By platform I am referring to the S-CORE repo release, which then would contain multiple sw modules

Also what is the git branching strategy? Will we have an separate Release Branch for Platform and all Modules?

TODO: I will add a proposal for the git branching strategy

hoe-jo · 2025-03-10T07:06:01Z

docs/process/process_areas/release_management/guidance/release_guideline.rst

+   * Each software module is contained in its own GitHub repository.
+   * Ensure that the repository follows the standard naming conventions and structure.
+
+2. **Release Planning**:


Is there a template for the release planning available? If so please link it!

I was thinking to create a planning template, but I had the feeling that this is upon the decision of the project leads/technical leads how they want to plan.

hoe-jo · 2025-03-10T07:07:17Z

docs/process/process_areas/release_management/guidance/release_guideline.rst

+
+   * Create a release plan for each software module.
+   * The release plan should include timelines, milestones, and deliverables.
+   * Coordinate with other module owners to align release schedules.


Should the module release plan not but aligned with the platform release any only other dependend modules?

As for my understanding the modules are individually managed but there should be a bi directional dialogue to align needs and timelines

hoe-jo · 2025-03-10T07:07:51Z

docs/process/process_areas/release_management/guidance/release_guideline.rst

+
+   * Follow the development guidelines and coding standards.
+   * Conduct thorough testing, including unit tests, integration tests, and system tests.
+   * Ensure that all tests pass before proceeding to the release.


or justify if there are failing tests?

Maybe link guideline for implementation and testing?

or justify if there are failing tests?

I think this addition makes sense, to add the possibility to justify test results, but generally that shouldn't be the norm, hence it was not mentioned
TODO: Mention the possibility to justify failed test cases

hoe-jo · 2025-03-10T07:15:59Z

docs/process/process_areas/release_management/guidance/release_guideline.rst

+
+4. **Release Preparation**:
+
+   * Update the version number according to the versioning policy.


Is the versioning policy already defined?

I think we should describe it as a part of the release management. Maybe start with what we already have 0.5, 1.0, ...?

Is the versioning policy already defined?

Thank you for pointing that out. I think the versioning policy deserves its own chapter in the guideline
TODO: Add Versioning Policy Chapter

hoe-jo · 2025-03-10T07:16:59Z

docs/process/process_areas/release_management/guidance/release_guideline.rst

+
+1. **Integration of Software Modules**:
+
+   * The platform release in the integrates various software modules.


typo: in the

TODO: Fix typo

aschemmel-tech

see inline comments

aschemmel-tech · 2025-03-10T07:24:46Z

docs/process/process_areas/release_management/release_roles.rst

+   * :need:`Project Lead <rl__project_lead>`
+
+A detailed overview of the responsibility for the steps of the Release Management process
+is listed here:


there is nothing linked "here:"

TODO: Add link

aschemmel-tech · 2025-03-10T07:32:40Z

docs/process/process_areas/release_management/release_workflow.rst

+   :contains: gd_temp__rel__mod_rel_note
+   :has: doc_concept__req__process, doc_concept__req__process
+
+The module release note provides clarity what is included in the current version of the software


please indent here, so that the text gets part of the need (same for other workflows, as example see workproducts)

TODO: Fix Indent

aschemmel-tech · 2025-03-10T07:38:40Z

docs/process/process_areas/release_management/release_workflow.rst

+   :tags: release_management
+   :responsible: rl__technical_lead
+   :approved_by: rl__project_lead
+   :input: wp__module_safety_case, wp__module_sw_release_plan


I would add also the wp__module_sw_verification_report as an input

TODO: Add wp__module_sw_verification_report

aschemmel-tech · 2025-03-10T07:39:10Z

docs/process/process_areas/release_management/release_workflow.rst

+   :tags: release_management
+   :responsible: rl__technical_lead
+   :approved_by: rl__project_lead
+   :input: wp__module_safety_case, wp__platform_sw_release_plan


I think rather the platform safety case

TODO: Replace module safety case with platform safety case

TODO: Adapt the module safety case to use instead the platform safety case

aschemmel-tech · 2025-03-10T07:39:27Z

docs/process/process_areas/release_management/release_workflow.rst

+   :tags: release_management
+   :responsible: rl__technical_lead
+   :approved_by: rl__project_lead
+   :input: wp__module_safety_case, wp__platform_sw_release_plan


Would also add wp__platform_sw_verification_report

TODO: Add wp__platform_sw_verification_report

TODO: Add suggestion

aschemmel-tech · 2025-03-10T09:05:45Z

docs/process/process_areas/release_management/guidance/release_guideline.rst

+
+5. **Release Execution**:
+
+   * Push the release to the main branch.


it is not clear what "the release" is? Is it the release note? A release branch that is merged back?

Push the release refers to the act of pushing the last necessary changes to the main branch in order to be able to release

aschemmel-tech · 2025-03-10T09:06:28Z

docs/process/process_areas/release_management/guidance/release_guideline.rst

+5. **Release Execution**:
+
+   * Push the release to the main branch.
+   * Create a release in the GitHub repository and attach the release notes.


Confusing: First "push" and then "create"?

Push the release refers to the act of pushing the last necessary changes to the main branch.
The create refers to the github process of creating a release which is called on the github help pages Creating a release
https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository

aschemmel-tech · 2025-03-10T09:08:41Z

docs/process/process_areas/release_management/guidance/release_templates.rst

+   | Known Issues
+   | ------------
+   |
+   | - **Issue 1**: Brief description of the known issue.


and a statement how it does affect safety

TODO: Adjusted template to mention safety

aschemmel-tech · 2025-03-10T09:10:59Z

docs/process/process_areas/release_management/guidance/index.rst

+   :maxdepth: 1
+
+   release_guideline
+   release_templates


do we need a release checklist?

In my opinion it isn't necessary

aschemmel-tech · 2025-03-10T09:14:29Z

docs/process/process_areas/release_management/guidance/index.rst

+   :maxdepth: 1
+
+   release_guideline
+   release_templates


I would also suggest we have a "release issue template" to implement the "release plan" which we link to a milestone defined by project management and define in it the steps to do for a release. And "close" this with a "release note" PR.

aschemmel-tech · 2025-03-10T09:38:09Z

docs/process/process_areas/release_management/release_concept.rst

+   # *******************************************************************************
+
+Concept Description
+###################


we also need to fill out the https://github.com/eclipse-score/score/blob/main/docs/platform_management_plan/release_management.rst document - there we should define what we release: not a executable build SW but only a set of source code files with verification and documentation collaterals.

// Fixes based on comments TODO: text and marked with a thumbs up - Added proposal for the git branching strategy. - Mentioned the possibility to justify failed test cases. - Added Versioning Policy Chapter. - Fixed typo in release concept. - Added link to detailed overview of responsibilities. - Fixed indent in release workflow. - Added wp__module_sw_verification_report to inputs. - Replaced module safety case with platform safety case. - Adapted module safety case to use platform safety case. - Added wp__platform_sw_verification_report to inputs. - Added wp__platform_mgmt and wp__issue_track_system to inputs. - Changed status to valid for work products. - Adapted inputs and separated outputs list. - Slight rework of wording to capture "feature requests". - Added release note mention for each module. - Changed wording from Version to Release Tag and added hash. - Adapted wording to refer to tech lead circle instead of platform release manager. - Changed wording to "publish within Eclipse SDV". - Mentioned tech lead circle for periodic meetings. - Adjusted template to mention safety in known issues. Resolves: eclipse-score#313

…ss' into kroehnd_release_management_process

FScholPer assigned kroehnd Mar 6, 2025

FScholPer linked an issue Mar 6, 2025 that may be closed by this pull request

Improvement: Document Release Management Process #313

Open

FScholPer requested review from aschemmel-tech and Aymen-Soussi-01 March 6, 2025 09:15

FScholPer changed the title ~~Added initial release managmenet process description. Edited process_…~~ Added initial release management process description. Mar 6, 2025

kroehnd force-pushed the kroehnd_release_management_process branch from 8e11f9e to 5173fcd Compare March 7, 2025 05:52

masc2023 added this to the SCORE Process Audit 3 milestone Mar 7, 2025

kroehnd force-pushed the kroehnd_release_management_process branch from 5173fcd to 02c9c1e Compare March 7, 2025 08:49

Merge branch 'eclipse-score:main' into kroehnd_release_management_pro…

0aea877

…cess

hoe-jo reviewed Mar 10, 2025

View reviewed changes

aschemmel-tech requested changes Mar 10, 2025

View reviewed changes

aschemmel-tech reviewed Mar 10, 2025

View reviewed changes

masc2023 linked an issue Mar 10, 2025 that may be closed by this pull request

Epic: (Initial) Processes Release Management #613

Open

kroehnd added 2 commits March 12, 2025 17:54

Merge remote-tracking branch 'origin/kroehnd_release_management_proce…

865e7d5

…ss' into kroehnd_release_management_process


		4. Release Preparation:

		* Update the version number according to the versioning policy.


		1. Integration of Software Modules:

		* The platform release in the integrates various software modules.


		5. Release Execution:

		* Push the release to the main branch.

Added initial release management process description. #578

Are you sure you want to change the base?

Added initial release management process description. #578

Conversation

FScholPer commented Mar 6, 2025

github-actions bot commented Mar 6, 2025 • edited Loading

License Check Results

github-actions bot commented Mar 6, 2025

masc2023 commented Mar 7, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kroehnd Mar 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kroehnd Mar 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aschemmel-tech left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Mar 6, 2025 •

edited

Loading

kroehnd Mar 11, 2025 •

edited

Loading

kroehnd Mar 11, 2025 •

edited

Loading