Skip to content
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

Release v3.0.0/trgs: updated docs to align with TRGs #312

Merged
merged 9 commits into from
May 10, 2024
Merged

Release v3.0.0/trgs: updated docs to align with TRGs #312

merged 9 commits into from
May 10, 2024

Conversation

saudkhan116
Copy link
Contributor

Why we create this PR?

This PR contains the following changes:

  • Renamed the following readme files in /docs
    - docs/admin guide/ -> docs/admin/
    - docs/arch42/ -> docs/architecture/
    - docs/userManual/ -> docs/user/
    - docs/infrastcuture as code/ -> docs/security/infrastructure-as-code/
    - docs/secrets management/SECRET_MANAGEMENT.md -> docs/security/secrets-management/SecretsManagement.md
    - docs/data retrieval guide/data-retrieval -> docs/data-retrieval/README.md
    - docs/business statement/ -> docs/interoperability/Interoperability.md
  • Updated all relevant references from the above files
  • Updated dpp helm values
  • Removed values-dev.yaml and values-beta.yaml from helm charts

What we want to achieve with this PR?

To be compliant with the Release guidelines https://eclipse-tractusx.github.io/docs/release for the QG 24.05

What is new?

Updated

  • Renamed the following readme files in /docs
    - docs/admin guide/ -> docs/admin/
    - docs/arch42/ -> docs/architecture/
    - docs/userManual/ -> docs/user/
    - docs/infrastcuture as code/ -> docs/security/infrastructure-as-code/
    - docs/secrets management/SECRET_MANAGEMENT.md -> docs/security/secrets-management/SecretsManagement.md
    - docs/data retrieval guide/data-retrieval -> docs/data-retrieval/README.md
    - docs/business statement/ -> docs/interoperability/Interoperability.md
  • Updated all relevant references from the above files
  • Updated dpp helm values

Deleted

  • Removed values-dev.yaml and values-beta.yaml from helm charts

Linked Issues:

#263

@saudkhan116 saudkhan116 requested a review from matbmoser May 10, 2024 08:30
github-advanced-security[bot]
github-advanced-security bot found potential problems May 10, 2024
View reviewed changes
charts/digital-product-pass/templates/secret-backend.yaml Outdated
---

apiVersion: v1
kind: Secret
metadata:
name: {{ .Release.Name }}-avp-consumer-backend-edc-oauth
name: {{ .Release.Name }}-backend-edc-oauth

Check warning

Code scanning / KICS

Using Unrecommended Namespace Warning

metadata.namespace is undefined or null
charts/digital-product-pass/templates/secret-backend.yaml Outdated
@@ -25,7 +25,7 @@
apiVersion: v1
kind: Secret
metadata:
name: {{ .Release.Name }}-avp-consumer-backend-auth
name: {{ .Release.Name }}-backend-auth

Check warning

Code scanning / KICS

Using Unrecommended Namespace Warning

metadata.namespace is undefined or null
charts/digital-product-pass/templates/secret-backend.yaml Outdated
@@ -25,7 +25,7 @@
apiVersion: v1
kind: Secret
metadata:
name: {{ .Release.Name }}-avp-consumer-backend-auth
name: {{ .Release.Name }}-backend-auth

Check notice

Code scanning / KICS

Using Kubernetes Native Secret Management

External secret storage is not in use
charts/digital-product-pass/templates/secret-backend.yaml Outdated
---

apiVersion: v1
kind: Secret
metadata:
name: {{ .Release.Name }}-avp-consumer-backend-edc-oauth
name: {{ .Release.Name }}-backend-edc-oauth

Check notice

Code scanning / KICS

Using Kubernetes Native Secret Management

External secret storage is not in use
@saudkhan116 saudkhan116 added this to the v3.0.0 (R24.05) milestone May 10, 2024
github-advanced-security[bot]
github-advanced-security bot found potential problems May 10, 2024
View reviewed changes
...ductpass/src/main/java/org/eclipse/tractusx/digitalproductpass/services/ContractService.java Outdated

Long validUntil = dtr.getValidUntil();
//Check if invalid time has come
if (dtr.getInvalid() && validUntil > currentTimestamp) {

Check warning

Code scanning / CodeQL

Dereferenced variable may be null

Variable [validUntil](1) may be null at this access as suggested by [this](2) null guard.
@saudkhan116 saudkhan116 added documentation Improvements or additions to documentation helm-charts Issue or PR connected to the helm charts configuration labels May 10, 2024
@saudkhan116 saudkhan116 linked an issue May 10, 2024 that may be closed by this pull request
[DPP] [TRGs] [R24.05] Tractus-X Release Guidelines fulfilled #263
Closed
39 tasks
matbmoser
matbmoser approved these changes May 10, 2024
View reviewed changes
Copy link
Contributor

@matbmoser matbmoser left a comment

Choose a reason for hiding this comment

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

Just documentation and updates from the trgs, I just bumped up one version from the charts so we can be compliant with the guidelines of publishing chart versions when changed.

@saudkhan116 saudkhan116 merged commit 295caf7 into eclipse-tractusx:main May 10, 2024
5 of 7 checks passed
@saudkhan116 saudkhan116 deleted the release-v3.0.0/trgs branch May 10, 2024 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matbmoser matbmoser matbmoser approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation helm-charts Issue or PR connected to the helm charts configuration
Projects
Digital Product Pass
Status: Done
Milestone
v3.0.0 (R24.05)
Development

Successfully merging this pull request may close these issues.

[DPP] [TRGs] [R24.05] Tractus-X Release Guidelines fulfilled
2 participants
@saudkhan116 @matbmoser