Skip to content

docs: takeover release mgt #866

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: takeover release mgt #866

wants to merge 2 commits into from

Conversation

aschemmel-tech
Copy link
Contributor

No description provided.

@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 7, 2025 •
edited
Loading

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //:license-check

Status: ✅ Passed

Click to expand output 
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server and connecting to it...
INFO: Invocation ID: 1951e27e-34ae-46bb-aeec-d690ea3c816f
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //:license-check (90 packages loaded, 10 targets configured)

Analyzing: target //:license-check (98 packages loaded, 10 targets configured)

Analyzing: target //:license-check (130 packages loaded, 1593 targets configured)

Analyzing: target //:license-check (138 packages loaded, 1644 targets configured)

Analyzing: target //:license-check (145 packages loaded, 2465 targets configured)

Analyzing: target //:license-check (146 packages loaded, 2589 targets configured)

Analyzing: target //:license-check (149 packages loaded, 4611 targets configured)

INFO: Analyzed target //:license-check (150 packages loaded, 4737 targets configured).
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 15.897s, Critical Path: 0.45s
INFO: 13 processes: 4 disk cache hit, 9 internal.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./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 76 items.
[main] INFO Found 52 items.
[main] INFO Querying ClearlyDefined for license data for 24 items.
[main] INFO Found 24 items.
[main] INFO Vetted license information was found for all content. No further investigation is required.

@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 7, 2025

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

@aschemmel-tech aschemmel-tech force-pushed the aschemmel-tech-takeover_release_mgt branch from 63c68b3 to ccaad1b Compare April 7, 2025 14:39
@aschemmel-tech aschemmel-tech changed the title Aschemmel tech takeover release mgt docs: takeover release mgt Apr 7, 2025
@aschemmel-tech aschemmel-tech marked this pull request as ready for review April 7, 2025 15:07
masc2023
masc2023 reviewed Apr 7, 2025
View reviewed changes
Copy link
Contributor

@masc2023 masc2023 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As initial fine for me, let's discuss some findings in the next meeting

docs/process/process_areas/release_management/release_concept.rst Outdated
Platform Release
================

The Platform Release contains the full *SCORE* scope which spans over many modules. The releases
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SCORE -> S-CORE, may check complete document

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that was the only occurrence, changed

docs/process/process_areas/release_management/release_concept.rst
Inputs
******

#. Module safety package
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Workflows have more inputs, shall that be consistent?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added missing input

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_package, wp__module_sw_release_plan, wp__verification__module_ver_report
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the report not anyhow part of the package?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to make it specific

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

4. **Release Preparation**:

* Update the version number according to the versioning policy.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we have a policy? Link to it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added link

docs/platform_management_plan/release_management.rst Outdated
It is part of project planning and therefore also documented with the same means. Generally a Release
is planned as an issue linked to a milestone in the `GitHub Milestone Planning <https://github.com/orgs/eclipse-score/projects/13>`_.
And this issue is closed by merging a pull request which creates/updates a release note.
Currently decided S-CORE releases are 0.5 and 1.0. The steps until 0.5 release are already planned.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May just link to the current roadmap is sufficient and also valid in future?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the statement

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

5. **Release Execution**:

* Create a release in the GitHub repository release branch and attach the release notes. For this consider the `GitHub Howto Release <https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository/>`_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

may add required topics as tagging, you ask in the next step for it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not understood, tags may be created before or during the "release" as desribed in the github link. We defined to do it already in step 4.

@aschemmel-tech aschemmel-tech force-pushed the aschemmel-tech-takeover_release_mgt branch from ccaad1b to 19a32eb Compare April 8, 2025 09:29
@aschemmel-tech
Copy link
Contributor Author

want to wait for Anton to come back with feedback of the TL round on the topic of branches (do we want to have these or rely fully on feature flags).

@aschemmel-tech aschemmel-tech force-pushed the aschemmel-tech-takeover_release_mgt branch 2 times, most recently from 3ced04c to 28ad7d7 Compare April 11, 2025 13:33
@aschemmel-tech aschemmel-tech force-pushed the aschemmel-tech-takeover_release_mgt branch from 28ad7d7 to b80e0a6 Compare April 11, 2025 13:36
johannes-esr
johannes-esr reviewed Apr 17, 2025
View reviewed changes
docs/process/process_areas/release_management/release_concept.rst
==================

Branches:
* main: Stable, production-ready code.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my perception main was the development branch. Or do we want to introduce a seperate branch for the development?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@masc2023 masc2023 masc2023 left review comments

@johannes-esr johannes-esr johannes-esr left review comments

@antonkri antonkri Awaiting requested review from antonkri

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@aschemmel-tech @masc2023 @johannes-esr