Skip to content

Commit

Permalink
Merge branch 'main' into feat/update-issue-template-feature
Browse files Browse the repository at this point in the history
  • Loading branch information
stephanbcbauer authored Oct 2, 2024
2 parents 6eda94f + 8793eee commit b3c1ee0
Show file tree
Hide file tree
Showing 51 changed files with 1,351 additions and 335 deletions.
35 changes: 12 additions & 23 deletions .github/ISSUE_TEMPLATE/3_product_release_checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,50 +2,40 @@
name: Product Release Checks
about: Use this template to track all release checks for your component
title: "[Product] Release Checks"
labels: compliance, documentation, "security analysis", "test results"
---

> [!IMPORTANT]
> Follow the [guidance on how to use the templates](https://github.com/eclipse-tractusx/sig-release/blob/main/README.md#release-management-acceptance-criteria).
## Release Info

Please provide information on what you want to be included in the Eclipse Tractus-X release.
If you are not owner of this issue, please provide the information as comment to the issue.
To receive review from committer or subject matter expert, assign the issue to the person.
Make sure to assign this issue to expert(s) for their approval, as soon as you have finished preparation. Multiple assignees allowed; they will un-assign themselves once review completed.

**Version to be included in Eclipse Tractus-X release**: *version placeholder*

**Leading product repository:** *repository link*

# Compliance Verifications

This issue tracks all compliance related checks, that need to be performed for a product release in Eclipse Tractus-X.
This issue tracks all checks, that need to be performed for a product release in Eclipse Tractus-X.

- [ ] **Gaia-X** compliance confirmed
- [ ] **GDPR** compliance confirmed (personal data, data protection + privacy DPP)
- [ ] **Interoperability** checks performed
- [ ] **Data Sovereignty** checks performed
- [ ] Compliant with relevant _published_ **CX Standards** (see the [Catena-X standard library](https://catena-x.net/en/standard-library))

# Documentation
# General Checks

- [ ] **Arc24** documentation up-to-date
- [ ] **Administrators Guide** up-to-date
- [ ] **End-User manual** up-to-date
- [ ] **Interface documentation** up-to-date
- [ ] [**Tractus-X Release Guidelines**](https://eclipse-tractusx.github.io/docs/release)(TRGs) fulfilled

# Security Checks
Make sure to open and fill in a separate **documentation issue** in your product repository using the [Quality Gate Checklist issue template](https://github.com/eclipse-tractusx/.github/blob/main/.github/ISSUE_TEMPLATE/qg-checklist.md)

- [ ] **Thread Modelling Analysis** passed
- [ ] **Static Application Security Testing** (SAST) scans passed
- [ ] **Dynamic Application Security Testing** (DAST) tests passed
- [ ] **Secret Scans** passed
- [ ] **Software Composition Analysis** (SCA) passed
- [ ] **Container Scans** passed
- [ ] **Infrastructure as Code** (IaC) scans passed
> [!NOTE]
> Note: most criteria for documentation and security are now covered in TRGs
# General Checks
# Security Checks

- [ ] [**Tractus-X Release Guidelines**](https://eclipse-tractusx.github.io/docs/release) fulfilled
- [ ] Compliant with the **Style Guide**
- [ ] **Threat Modeling Analysis** passed

# Test Results

Expand All @@ -55,4 +45,3 @@ This issue tracks all compliance related checks, that need to be performed for a
# Helpful Links

- [Eclipse Tractus-X openAPI specs on SwaggerHub](https://app.swaggerhub.com/search?owner=eclipse-tractusx-bot)
- [Catena-X standard library](https://catena-x.net/en/standard-library)
15 changes: 13 additions & 2 deletions .github/ISSUE_TEMPLATE/4_KIT_release_checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,34 @@ title: "[KIT NAME] Release Checks"
labels: kit
---

This issue tracks all relevant release checks for KITs.
This issue tracks all relevant release checks for your KIT.

> [!IMPORTANT]
> Follow the [guidance on how to use the templates](https://github.com/eclipse-tractusx/sig-release/blob/main/README.md#release-management-acceptance-criteria).
## Release Info

Please provide information on what you want to be included in the Eclipse Tractus-X release.
If you are not owner of this issue, please provide the information as comment to the issue.
Have your prepared content reviewed by a professional peer group before submitting it for committer approval.
Best practice: have a professional Peer review your prepared content before you submit for expert approvals.
Please link the open or merged PR that includes the changes.

**Version to be included in Eclipse Tractus-X release:** *version placeholder*
- KIT semantic version of change log.
- Date of KIT publication must be aligned with overall release date.

If changes to your KIT are not yet live on [our website](https://eclipse-tractusx.github.io/developer), link the open PR introducing the changes for this release.

If changes are already live, also point out the PRs witch included the changes for this version if possible.
Please refer to TRG 8.03 for the classification of mandatory and optional artefacts.

- [PR number](pr-url)

# General

- [ ] **CHANGELOG** available and maintained
- [ ] [**Tractus-X Release Guidelines**](https://eclipse-tractusx.github.io/docs/release) fulfilled


# Adoption View

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-and-deploy-dashboard.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ jobs:

# Docs: https://github.com/peaceiris/actions-gh-pages
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: "${{ env.DASHBOARD_DIR }}/build"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release-notifier.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ env:
DEVSECOPS_NOTIFICATION_EMAIL: [email protected]
DEVSECOPS_NOTIFICATION_EMAIL_PASSWORD: ${{ secrets.NOTIFICATION_EMAIL_PASSWORD }}
CURRENT_ALIGNED_PSQL_VER: 15.0.0
CURRENT_ALIGNED_K8S_VER: 1.27.0
CURRENT_ALIGNED_K8S_VER: 1.28.9
jobs:
notify:
runs-on: ubuntu-latest
Expand All @@ -44,7 +44,7 @@ jobs:
with:
go-version: '>=1.20.7'
- name: Download artifact
uses: dawidd6/action-download-artifact@v3
uses: dawidd6/action-download-artifact@v6
with:
workflow: ${{ github.event.workflow_run.workflow_id }}
workflow_conclusion: success
Expand Down
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,30 @@ Catena-X alliance focusing on parts traceability.

* https://projects.eclipse.org/projects/automotive.tractusx

## Project licenses

The Tractus-X project uses the following licenses:

* Apache-2.0 for code
* CC-BY-4.0 for non-code

## Terms of Use

This repository is subject to the Terms of Use of the Eclipse Foundation

* https://www.eclipse.org/legal/termsofuse.php

## Developer resources

Information regarding source code management, builds, coding standards, and
more.

* https://projects.eclipse.org/projects/automotive.tractusx/developer

Getting started:

* https://eclipse-tractusx.github.io/docs/developer

The project maintains the following source code repositories

* https://github.com/eclipse-tractusx/sig-release
Expand Down
Loading

0 comments on commit b3c1ee0

Please sign in to comment.