Skip to content

Commit

Permalink
Merge pull request eclipse-tractusx#826 from mkanal/chore/eclipse-tra…
Browse files Browse the repository at this point in the history
…ctusx#817-QG-checks-release-24_08

Chore/eclipse-tractusx#817 qg checks release 24 08
  • Loading branch information
ds-jhartmann authored Jul 18, 2024
2 parents ff05add + 73eb268 commit e3e1b52
Show file tree
Hide file tree
Showing 10 changed files with 26 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .github/actions/import-gpg-key/action.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright (c) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
# Copyright (c) 2021,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
# Copyright (c) 2021,2024 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
Expand Down
4 changes: 3 additions & 1 deletion AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,6 @@ The following people have contributed to this repository:
- Pawel Sosnowski, doubleSlash Net-Business GmbH, https://github.com/ds-psosnowski
- Matthias Fischer, doubleSlash Net-Business GmbH, https://github.com/dsmf
- Sebastian Ceronik, doubleSlash Net-Business GmbH, https://github.com/ds-ext-sceronik
- Maximilian Wesener, doubleSlash Net-Business GmbH, https://github.com/ds-mwesener
- Maximilian Wesener, doubleSlash Net-Business GmbH, https://github.com/ds-mwesener
- Kama Gassner, doubleSlash Net-Business GmbH, https://github.com/ds-kgassner
- Philipp Weick, doubleSlash Net-Business GmbH, https://github.com/ds-pweick
4 changes: 2 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ Or create a new Helm chart and use the IRS as a dependency.
dependencies:
- name: item-relationship-service
repository: https://eclipse-tractusx.github.io/item-relationship-service
version: 6.x.x
version: 7.x.x
- name: tractusx-connector
repository: https://eclipse-tractusx.github.io/tractusx-edc
version: 0.5.x
version: 0.7.x
```

Then provide your configuration as the values.yaml of that chart.
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The IRS project consists of several different parts:
| .idea | Configuration for development via [IntelliJ](https://www.jetbrains.com/idea/). | |
| .run | Run configurations for running the IRS in [IntelliJ](https://www.jetbrains.com/idea/). | |
| charts | [HELM](https://helm.sh/) charts. | |
| charts/item-relationship-service | IRS [HELM](https://helm.sh/) chart for running the IRS with and its direct dependencies in [kubernetes](https://kubernetes.io/). | [IRS HELM charts documentation](charts/item-relationship-service/README.md) |
| charts/item-relationship-service | IRS [HELM](https://helm.sh/) chart for running the IRS with and its direct dependencies in [Kubernetes](https://kubernetes.io/). | [IRS HELM charts documentation](charts/item-relationship-service/README.md) |
| docs | Concepts and documentation. | [Docs README](docs/README.md) |
| irs-api | The IRS API. | |
| irs-common | Common classes of the IRS. | |
Expand All @@ -66,19 +66,20 @@ The IRS project consists of several different parts:
| irs-policy-store | The IRS policy store, an API to store and retrieve accepted EDC policies. | |
| irs-registry-client | Digital Twin Registry Client. | [Digital Twin Registry Client README](irs-registry-client/README.md) |
| irs-report-aggregate | This Maven module aggregates the test coverage reports of all modules. | |
| irs-testdata-upload | This Maven module contains the Testdata Utilities | |
| irs-testing | This module contains testing utilities for the IRS like [testcontainers](https://java.testcontainers.org/), [Wiremock](https://wiremock.org/) configurations and requests etc. | |
| local | This folder contains resources for local development and demonstration. | |
| local/demo | Showcases the IRS ESS top-down investigation use-case. | [ess-demo.py README](local/demo/README.md) |
| local/deployment | [HELM](https://helm.sh/) charts for local deployment of the IRS. | |
| local/development | This folder contains resources relevant for setting up the local development environment such as the [commit message check hook](CONTRIBUTING.md#commit-messages). | |
| local/testing/api-tests | [Tavern](https://tavern.readthedocs.io) API tests for the IRS. | [Tavern API Tests README](local/testing/api-tests/README.md) |
| local/testing/request-collection | [REST Request Collection](local/testing/request-collection/IRS_Request_Collection.json) for [Insomnia](https://insomnia.rest/). | [REST Request Collection README](local/testing/request-collection/README.md) |
| local/testing/api-tests | [Tavern](https://tavern.readthedocs.io) API tests for the IRS. | [Tavern API Tests README](local/testing/api-tests/README.md) |
| local/testing/testdata | Test data. | [Test data README](local/testing/testdata/README.md) |


## Installation

This section describes both deployment on [kubernetes](https://kubernetes.io) via [Helm](https://helm.sh/) and local deployment for development.
This section describes both deployment on [Kubernetes](https://kubernetes.io) via [Helm](https://helm.sh/) and local deployment for development.

### Helm Deployment

Expand Down
6 changes: 2 additions & 4 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# Security Policy

## Reporting a Vulnerability

Please do **not** report security vulnerabilities through public GitHub issues.

Please report vulnerabilities to this repository via **GitHub security advisories** instead.

__How?__ Inside affected repository --> security tab
How? Inside affected repository --> security tab

for contributor:
--> Report a vulnerability
Expand All @@ -16,4 +14,4 @@ for committer:

In severe cases, you can also report a found vulnerability via mail or eclipse issue here: https://www.eclipse.org/security/

See [Eclipse Foundation Vulnerability Reporting Policy](https://www.eclipse.org/projects/handbook/#vulnerability).
See [Eclipse Foundation Vulnerability Reporting Policy](https://www.eclipse.org/projects/handbook/#vulnerability)
7 changes: 6 additions & 1 deletion USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,15 @@ curl -X 'POST' \
"aspects": [
"SerialPart"
],
"key": {
"globalAssetId": "urn:uuid:00000000-0000-0000-0000-000000000000",
"bpn": "BPNL000000000000"
}
"bomLifecycle": "asBuilt",
"depth": 1,
"direction": "downward",
"globalAssetId": "urn:uuid:8a61c8db-561e-4db0-84ec-a693fc5ffdf6"
"collectAspects": true,
"callbackUrl": "https://hostname.com/callback?id={id}&state={state}"
}'
```

Expand Down
4 changes: 2 additions & 2 deletions docs/src/docs/administration/administration-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ include::troubleshooting.adoc[leveloffset=+1]
This work is licensed under the https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0].

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021, 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- SPDX-FileCopyrightText: 2021, 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- SPDX-FileCopyrightText: 2022, 2023 BOSCH AG
- SPDX-FileCopyrightText: 2021, 2022 ZF Friedrichshafen AG
- SPDX-FileCopyrightText: 2022 ISTOS GmbH
- SPDX-FileCopyrightText: 2021, 2023 Contributors to the Eclipse Foundation
- SPDX-FileCopyrightText: 2021, 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/item-relationship-service
4 changes: 2 additions & 2 deletions docs/src/docs/arc42/full.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ include::glossary.adoc[leveloffset=+1]
This work is licensed under the https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0].

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021, 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- SPDX-FileCopyrightText: 2021, 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- SPDX-FileCopyrightText: 2022, 2023 BOSCH AG
- SPDX-FileCopyrightText: 2021, 2022 ZF Friedrichshafen AG
- SPDX-FileCopyrightText: 2022 ISTOS GmbH
- SPDX-FileCopyrightText: 2021, 2023 Contributors to the Eclipse Foundation
- SPDX-FileCopyrightText: 2021, 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/item-relationship-service
4 changes: 2 additions & 2 deletions docs/src/docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ xref:swagger-ui/index.adoc[Swagger-UI]
This work is licensed under the https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0].

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021, 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- SPDX-FileCopyrightText: 2021, 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- SPDX-FileCopyrightText: 2022, 2023 BOSCH AG
- SPDX-FileCopyrightText: 2021, 2022 ZF Friedrichshafen AG
- SPDX-FileCopyrightText: 2022 ISTOS GmbH
- SPDX-FileCopyrightText: 2021, 2023 Contributors to the Eclipse Foundation
- SPDX-FileCopyrightText: 2021, 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/item-relationship-service
4 changes: 2 additions & 2 deletions docs/src/docs/swagger-ui/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
This work is licensed under the https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0].

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021, 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- SPDX-FileCopyrightText: 2021, 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- SPDX-FileCopyrightText: 2022, 2023 BOSCH AG
- SPDX-FileCopyrightText: 2021, 2022 ZF Friedrichshafen AG
- SPDX-FileCopyrightText: 2022 ISTOS GmbH
- SPDX-FileCopyrightText: 2021, 2023 Contributors to the Eclipse Foundation
- SPDX-FileCopyrightText: 2021, 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/item-relationship-service

0 comments on commit e3e1b52

Please sign in to comment.