From 56ecb577673f746b78fcaa2fa1de2055c9b3e930 Mon Sep 17 00:00:00 2001 From: Tom Meyer Date: Tue, 15 Oct 2024 11:11:34 +0200 Subject: [PATCH] docs: added reactivation process --- docs/release/trg-7/trg-7-09.md | 72 +++++++++++++++++++++++++++++++--- 1 file changed, 67 insertions(+), 5 deletions(-) diff --git a/docs/release/trg-7/trg-7-09.md b/docs/release/trg-7/trg-7-09.md index d27bfdd84f6..f9d3279e07b 100644 --- a/docs/release/trg-7/trg-7-09.md +++ b/docs/release/trg-7/trg-7-09.md @@ -28,14 +28,14 @@ In case of repositories belonging to a [Product](https://eclipse-tractusx.github **\*** The *past year's major release cycle* is the time span between the breaking change releases YY.06 e.g., 24.05 till 24.05. -### Process +### Deprecation Process To ensure the communities awareness the following process is used at least per major release planning: ```mermaid graph TD - A[1: Prepare list of unmaintained repositories] --> B[2-1 Inform Eclipse Tractus-X community] - B --> C[2-2: Draft critical issue for committer meeting] + A[1: Prepare list of unmaintained repositories] --> B[2-1: Draft critical issue for committer meeting] + B --> C[2-2: Inform Eclipse Tractus-X community] C --> D[3: 2 week period: Comment on issue for criteria discussion] D --> E[4-1: Committer meeting: Discuss list] E --> F[4-2: Send email to mailing list] @@ -43,14 +43,16 @@ graph TD G --> H{6: Action taken?} H -->|No| I[End of Release: Deprecate repository] H -->|Yes| J[Plan Update of repository] + J --> K[Create issue in .eclipsefdn] ``` 1. The committers prepare a list of unmaintained product repositories (**criteria 1**). -2. The committers inform the Eclipse Tractus-X community via the [mailing list](https://eclipse-tractusx.github.io/docs/oss/how-to-contribute/#dev-mailinglist). This is done by an issue with checkboxes listing all these repositories (find the issue template below). Additionally a critical issue is drafted on the [board for the committer meeting](https://github.com/orgs/eclipse-tractusx/projects/61/views/6) in at least 2 full weeks. +2. The committers inform the Eclipse Tractus-X community via the [mailing list](https://eclipse-tractusx.github.io/docs/oss/how-to-contribute/#dev-mailinglist). This is done by an issue with checkboxes listing all these repositories (find the issue template [below](#issue-template-for-deprecation-list)). Additionally a critical issue is drafted on the [board for the committer meeting](https://github.com/orgs/eclipse-tractusx/projects/61/views/6) in at least 2 full weeks. 3. 2 weeks period: The committers comment the issue regarding which repositories are subject to **criteria 1** and **criteria 2**. Also if **Criteria 2** does not apply, deprecation may still be possible due to security concerns. 4. Committer meeting: The committers discuss the list and check the boxes in the issue. A Mail is sent out to the Eclipse Tractus-X mailing list. This list is splitted into platform products (e.g. Tractus-X EDC) and use case products (e.g. PURIS). See a template below. 5. During the [Open Planning](https://catenax-ev.github.io/docs/next/working-model/release-management/planning/tx-release-planning-days) the deprecation proposal is communicated again. -6. If no action is taken, during the Release of the major version, the committers deprecate the repository and inform the association's release management. +6. If no action is taken, during the Release of the major version, the project leads will decide for the deprecation of the given repository and communicate accordingly with the Catena-X Association's release management or the specific organization responsible for the repository. +7. In case the repository got deprecated, and there is again maintainace or develop capacity, the following procedure **MUST** be followed [Repository Reactivation Process] by a committer. ### Issue Template for Deprecation List @@ -80,3 +82,63 @@ Following repositories are proposed to be subject to deprecation with the upcomi **Call to Action**: Please discuss within your company e.g., with your central Catena-X responsibles, whether you run into an issue. We highly encourage the companies to at least find resources for the **Platform Products** to maintain an open-source data space. ``` + +## Reactivation Guidelines + +Your repository got deprecated? No worries, follow the following steps to get it back on its feet: + +### Repository Reactivation Criteria + +In case a repository you are maintaining or want to maintain got deprecated after all the [Criteria for Deprecation](#criteria-for-deprecation) are fulfilled, and the [Deprecation Process](#deprecation-process) finalized, the following criteria **MUST** be fulfilled to reactivate your repository: + +1. The committer and requestor has capacity to resolve the security vulnerabilities and assure that the repository will comply to the latest TRGs. +2. Capacity to maintain the repository is available. +3. A solid reason is provided to reactivate the repository. + +### Repository Reactivation Process + +```mermaid +flowchart TD + A[1: Requestor creates an issue in the sig-infra repository following a template] --> B[2: Requestors sendd an email to the tractusx-dev mailing list informing of reponsible committer, issue id and reason for reactivation] + B --> C[3: Requestor informs the community in the office hour] + C --> D{Reactivation Criteria Fulfilled?} + D --> |NO| E[4: Project Lead closes the issue in Github] + D --> |YES| F[4: Project Lead opens issue in .eclipsefdn] + F --> G[5:Once reactivated, the Project Lead announces it in the mailing list] + G --> H[6: The Issue in sig-infra is closed] +``` + +1. The requestor **MUST** create an issue in the [sig-infra](https://github.com/eclipse-tractusx/sig-infra) repository following the template [below](#issue-template-for-reactivation). +2. The requestor **MUST** announce the repository reactivation proposal via an email to the [tractusx-dev](https://accounts.eclipse.org/mailing-list/tractusx-dev) mailing list mentioning the `issueId`, the `reason/motivation`. A`responsible committer` **MUST** be announced. +3. The requestor **MUST** inform the community within the Office Hour about the petition. +4. A project lead will open a issue at the [.eclipsefdn](https://github.com/eclipse-tractusx/.eclipsefdn) requesting the reactivation of the repository. +5. Once the respository is reactivated, the project lead sends a mail to the [tractusx-dev](https://accounts.eclipse.org/mailing-list/tractusx-dev) mailing list announcing the reactivation. +6. The project lead closes the issue in [sig-infra](https://github.com/eclipse-tractusx/sig-infra). + +### Issue Template for Reactivation + +```markdown +Title: Request for repository [] reactivation +Content: +## Context + +**Requester**: @a-contributor-or-committer-github-user +**Responsible Committer**: @a-committer-github-user + +**Respository to reactivate**: + +### Reason + + + +## Acknowledgments + +- [ ] I have checked and verified that the repository fulfills the [Reactivation Guidelines](https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-09) + +- [ ] I have emailed the mailing list announcing the committer assigned to the repository, providing a reasonable reason for the repository reactivation. + +- [ ] I have the consent of the committer, which will be responsible for making sure the latest [TRGs](https://eclipse-tractusx.github.io/docs/release) are followed. + +- [ ] The committer will monitor and take care that the open security issues of the reactivated repository. Following the [Security TRGs](https://eclipse-tractusx.github.io/docs/release/trg-8/trg-8-01) + +```