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.

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

Follow up SingleLevelUsageAsBuilt_2.0.0 #287

Conversation

johannsvarela
Copy link
Contributor

@johannsvarela johannsvarela commented Aug 24, 2023

Description

Since the colleague jacewski-bosch is on parental leave, we aren't able to update the exsting PR #198.

Therefore we created a new PR based 1:1 on the existing PR #198 with the original content of the branch single_level_usage_as_built_2.0.0 from the fork jacewski-bosch/sldt-semantic-models to be able to continue the MS approval check.

Closes #198 and #196.

MS2 Criteria

(to be filled out by PR reviewer)

  • the model validates with the BAMM SDS SDK in the version specified in the Readme.md of this repository by the time of the MS2 check (e.g., 'java -jar bamm-cli.jar -i <path-to-aspect-model> -v ). The SAMM CLI is available here and in GitHub
  • use Camel-Case (e.g., "MyModelElement" or "TimeDifferenceGmtId", when in doubt follow https://google.github.io/styleguide/javaguide.html#s5.3-camel-case)
  • the identifiers for all model elements start with a capital letter except for properties
  • the identifier for properties starts with a small letter
  • all model elements at least contain the fields "preferred name" and "description" in English language. The description must be comprehensible. It is not required to write full sentences but style should be consistent over the whole model
  • Property and the referenced Characteristic should not have the same name
  • the versioning in the URN follows semantic versioning, where minor version bumps are backwards compatible and major version bumps are not backwards compatible.
  • use abbreviations only when necessary and if these are sufficiently common
  • avoid redundant prefixes in property names (consider adding properties to an enclosing Entity or even adapt the namespace of the model elements, e.g., instead of having two properties DismantlerId and DismantlerName use an Entity Dismantler with the properties name and id or use a URN like io.catenax.dismantler:0.0.1)
  • fields preferredName and description are not the same
  • preferredName should be human readable and follow normal orthography (e.g., no camel case but normal word separation)
  • name of aspect is singular except if it only has one property which is a Collection, List or Set. In theses cases, the aspect name is plural.
  • units are referenced from the BAMM unit catalog whenever possible
  • use constraints to make known constraints from the use case explicit in the aspect model
  • when relying on external standards, they are referenced through a "see" element
  • all properties with an simple type have an example value
  • metadata.json exists with status "release"
  • generated json schema validates against example json payload
  • file RELEASE_NOTES.md exists and contains entries for proposed model changes
  • all contributors to this model are mentioned in copyright header of model file

MS3 Criteria

(to be filled out by semantic modeling team before merge to main-branch)

  • All required reviewers have approved this PR (see reviewers section)
  • The new aspect (version) will be implemented by at least one data provider
  • The new aspect (version) will be consumed by at least one data consumer
  • There exists valid test data
  • In case of a new (incompatible) major version to an existing version, a migration strategy has been developed
  • The model has at least version '1.0.0'
  • The release date in the Release Note is set to the date of the MS3 approval

Created ttl-file based 1:1 on existing SingleLevelUsageAsBuilt.ttl from the branch single_level_usage_as_built_2.0.0 of the fork jacewski-bosch/sldt-semantic-models
Created notes.md File based 1:1 on the existing RELEASE_NOTES.md from the branch single_level_usage_as_built_2.0.0 of the fork jacewski-bosch/sldt-semantic-models
@gitguardian
Copy link

gitguardian bot commented Aug 24, 2023

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request
GitGuardian id Secret Commit Filename
- Generic Password e6d299e io.catenax.single_level_usage_as_built/2.0.0/.log/debug.log View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!

@bs-jokri bs-jokri mentioned this pull request Aug 25, 2023
25 tasks
@bs-jokri
Copy link
Contributor

bs-jokri commented Aug 25, 2023

@johannsvarela please remove the .log folder from the PR, this seems to be mistakenly added to the PR. After that we should be good to go for MS2

-> just removed the log file on my own. Hope this is ok. So nothing to do from your side anymore here.

@bs-jokri bs-jokri added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Aug 25, 2023
@BenediktMuellerIML
Copy link
Contributor

modeling_team

@bs-jokri
Copy link
Contributor

@johannsvarela @BenediktMuellerIML the following two MS3 approval conditionally provided given

  • will inform test data management to changes in test data
  • migration strategy has been developed

No further presentation of the model is required. @johannsvarela @BenediktMuellerIML provide a comment as soon as the issues are resolved and the MS3 approval will be given.

@johannsvarela
Copy link
Contributor Author

@johannsvarela @BenediktMuellerIML the following two MS3 approval conditionally provided given

  • will inform test data management to changes in test data
  • migration strategy has been developed

No further presentation of the model is required. @johannsvarela @BenediktMuellerIML provide a comment as soon as the issues are resolved and the MS3 approval will be given.

@bs-jokri there are some updates regarding the missing points for the MS3 approval:

  • We have informed the test management team about the changes of this aspect model and requested to add the changes into the new test data that will be generated in the next days (see TDG-19). Therefore there is nothing more to do from our part as modelling team.
  • This aspect model was presented within the testdata alignment weekly, where the affected persons were informed about the changes that needs to be migrated. Therefore there is nothing more to do from our part as modelling team.

@bs-jokri bs-jokri added the MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br label Aug 31, 2023
@bs-jokri bs-jokri merged commit e54d26c into eclipse-tractusx:main Aug 31, 2023
@johannsvarela johannsvarela deleted the follow-up_single_level_usage_as_built_2.0.0 branch September 21, 2023 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
MS2_Approved Checklist "MS2 Valid Model" is approved. MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants