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

[Model Update]: Digital Product Passport #498

Merged
merged 11 commits into from
Dec 11, 2023
Merged

[Model Update]: Digital Product Passport #498

merged 11 commits into from
Dec 11, 2023

Conversation

catroest
Copy link
Contributor

@catroest catroest commented Nov 28, 2023 •
edited by agg3fe
Loading

Description

-->

Closes #472

MS2 Criteria

(to be filled out by PR reviewer)

  • the model validates with the SAMM SDS SDK in the version specified in the Readme.md of this repository by the time of the MS2 check (e.g., 'java -jar samm-cli.jar aspect <path-to-aspect-model> validate ). 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 SAMM 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'
  • If a previous model exists, model deprecation has been checked for previous model
  • The release date in the Release Note is set to the date of the MS3 approval

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.generic.digital_product_passport/3.0.0/DigitalProductPassport.ttl

Input model is valid

This was referenced Nov 28, 2023
Closed
Merged
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.generic.digital_product_passport/3.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.generic.digital_product_passport/3.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.generic.digital_product_passport/3.0.0/DigitalProductPassport.ttl

Input model is valid

@agg3fe
Copy link
Contributor

agg3fe commented Nov 28, 2023

@catroest is this ready for MS2? if yes, please remove gitignore file

@catroest
Copy link
Contributor Author

@catroest is this ready for MS2? if yes, please remove gitignore file

Yes this is ready for review. Why not update the gitignore to samm?

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.generic.digital_product_passport/3.0.0/DigitalProductPassport.ttl

Validation failed:

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.generic.digital_product_passport/3.0.0/DigitalProductPassport.ttl

Validation failed:

@agg3fe
Copy link
Contributor

agg3fe commented Nov 28, 2023

@catroest is this ready for MS2? if yes, please remove gitignore file

Yes this is ready for review. Why not update the gitignore to samm?

Ok understood your point. But it's fine, I will take care of gitignore file.

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.generic.digital_product_passport/3.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.generic.digital_product_passport/3.0.0/DigitalProductPassport.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.generic.digital_product_passport/3.0.0/DigitalProductPassport.ttl

Input model is valid

agg3fe
agg3fe approved these changes Nov 29, 2023
View reviewed changes
Copy link
Contributor

@agg3fe agg3fe left a comment

Choose a reason for hiding this comment

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

LGTM

@agg3fe agg3fe added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Nov 29, 2023
@catroest
MS3 approval by business team
d52c918 
- eclass changed back to optional
- spareParts exclusivly structured
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.generic.digital_product_passport/3.0.0/DigitalProductPassport.ttl

Input model is valid

@catroest
Copy link
Contributor Author

@agg3fe

small changes after the MS3 approval by the business team:

  • eclass changed back to optional
  • spareParts exclusivly structured

@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 4, 2023

Validation Report for io.catenax.generic.digital_product_passport/3.0.0/DigitalProductPassport.ttl

Input model is valid

@agg3fe agg3fe added the MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br label Dec 4, 2023
@catroest
Copy link
Contributor Author

catroest commented Dec 7, 2023

@jacewski-bosch can you merge? I need it for my model

@agg3fe agg3fe merged commit 9f3a2d0 into eclipse-tractusx:main Dec 11, 2023
4 checks passed
@catroest catroest deleted the DigitalProductPassport branch January 16, 2024 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agg3fe agg3fe agg3fe approved these changes

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Model Update]: Digital Product Passport
2 participants
@catroest @agg3fe