Added initial release management process description. #578
Conversation
License Check Results🚀 The license check preparation job ran successfully. Status: Click to expand output |
|
The created documentation from the pull request is available at: docu-html |
FScholPer
changed the title
kroehnd
force-pushed
the
kroehnd_release_management_process
branch
from
8e11f9e to
5173fcd
Compare
|
@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
kroehnd
force-pushed
the
kroehnd_release_management_process
branch
from
5173fcd to
02c9c1e
Compare
| * Creates and maintains the platform release plan | ||
| * Aligns with the *Tech Lead Circle* the timeline from various module release plans | ||
|
|
||
| Platform Release |
There was a problem hiding this comment.
What do you mean by platform release? Release of the score repository or the reference integration?
There was a problem hiding this comment.
Also what is the git branching strategy? Will we have an separate Release Branch for Platform and all Modules?
There was a problem hiding this comment.
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
| * Each software module is contained in its own GitHub repository. | ||
| * Ensure that the repository follows the standard naming conventions and structure. | ||
|
|
||
| 2. **Release Planning**: |
There was a problem hiding this comment.
Is there a template for the release planning available? If so please link it!
There was a problem hiding this comment.
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.
|
|
||
| * 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. |
There was a problem hiding this comment.
Should the module release plan not but aligned with the platform release any only other dependend modules?
There was a problem hiding this comment.
As for my understanding the modules are individually managed but there should be a bi directional dialogue to align needs and timelines
docs/process/process_areas/release_management/guidance/release_guideline.rst
Show resolved
Hide resolved
docs/process/process_areas/release_management/guidance/release_guideline.rst
Show resolved
Hide resolved
docs/process/process_areas/release_management/guidance/release_guideline.rst
Outdated
Show resolved
Hide resolved
docs/process/process_areas/release_management/release_workflow.rst
Outdated
Show resolved
Hide resolved
docs/process/process_areas/release_management/release_workflow.rst
Outdated
Show resolved
Hide resolved
docs/process/process_areas/release_management/release_workflow.rst
Outdated
Show resolved
Hide resolved
docs/process/process_areas/release_management/release_workflow.rst
Outdated
Show resolved
Hide resolved
|
|
||
| 5. **Release Execution**: | ||
|
|
||
| * Push the release to the main branch. |
There was a problem hiding this comment.
it is not clear what "the release" is? Is it the release note? A release branch that is merged back?
There was a problem hiding this comment.
Push the release refers to the act of pushing the last necessary changes to the main branch in order to be able to release
There was a problem hiding this comment.
Please align this now with the braching strategy, I would have thought we release in a branch and later merge the content back in the main?
| 5. **Release Execution**: | ||
|
|
||
| * Push the release to the main branch. | ||
| * Create a release in the GitHub repository and attach the release notes. |
There was a problem hiding this comment.
Confusing: First "push" and then "create"?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
ok, then please add this to description
docs/process/process_areas/release_management/guidance/release_templates.rst
Outdated
Show resolved
Hide resolved
| :maxdepth: 1 | ||
|
|
||
| release_guideline | ||
| release_templates |
There was a problem hiding this comment.
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.
| # ******************************************************************************* | ||
|
|
||
| Concept Description | ||
| ################### |
There was a problem hiding this comment.
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
masc2023
modified the milestones:
SCORE Process Audit 3,
Process & Tools Enable Testing
| .. _workflow_release: | ||
|
|
||
| Software Module Release | ||
| ----------------------- |
There was a problem hiding this comment.
there are two roles involved, it is not clear who does what, maybe refer to workflow where it is said that the TL is resoponsible and the PL approves, also recommend to include the release as a responsibility/authority to rl_project_lead and rl_technical_lead.
| #. Platform release plan | ||
| #. Platform release note | ||
|
|
||
| Platform Release Plan |
There was a problem hiding this comment.
Need to discuss in the process community if we need a release plan as a seperate wp. Also still there is no content in the PMP release management section.
| Inputs | ||
| ****** | ||
|
|
||
| #. Module safety case |
There was a problem hiding this comment.
in the meantime we renamed the "safety case"s to "safety package"
|
|
||
| #. :need:`Project Lead Circle <rl__project_lead>` | ||
|
|
||
| * Creates and maintains the platform release plan |
There was a problem hiding this comment.
still have another understanding of the PL's responsibility - in the workflows I think it is correcly defined.
| * Releases the platform | ||
|
|
||
| Module Release Plan | ||
| =================== |
There was a problem hiding this comment.
I think this is maybe a content we define together with the TL circle and document in the platform management plan.
|
|
||
| * Regularly update all stakeholders on the release status. | ||
| * Hold periodic meetings to discuss progress, issues, and dependencies. | ||
| * Ensure clear and transparent communication throughout the release process. |
There was a problem hiding this comment.
sorry, what I meant is that instead of describing our goal, we should describe how we can reach it.
|
|
||
| 5. **Release Execution**: | ||
|
|
||
| * Push the release to the main branch. |
There was a problem hiding this comment.
Please align this now with the braching strategy, I would have thought we release in a branch and later merge the content back in the main?
| 5. **Release Execution**: | ||
|
|
||
| * Push the release to the main branch. | ||
| * Create a release in the GitHub repository and attach the release notes. |
There was a problem hiding this comment.
ok, then please add this to description
| :maxdepth: 1 | ||
|
|
||
| release_guideline | ||
| release_templates |
| # ******************************************************************************* | ||
|
|
||
| Concept Description | ||
| ################### |
| :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 |
There was a problem hiding this comment.
This is a description of the work product and not of the workflow (activity) - please copy/align the text with the wp one and create a new description of the wf. Same remark for the other wf in this file.
…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