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

Shopfloor information types2 #257

Merged

Conversation

wehrstedt-jan
Copy link
Contributor

@wehrstedt-jan wehrstedt-jan commented Jul 13, 2023

Description

-->
Closes # #254

use of header of #227 required
Closes #

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 BAMM 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

samm:preferredName "Time Unit Enum"@en ;
samm:description "Enumerates all time units"@en ;
samm:dataType samm:curie ;
samm-c:values ( "unit:secondUnitOfTime"^^samm:curie "unit:minuteUnitOfTime"^^samm:curie "unit:hour"^^samm:curie "unit:day"^^samm:curie "unit:week"^^samm:curie "unit:month"^^samm:curie "unit:year"^^samm:curie ) .
Copy link
Contributor

Choose a reason for hiding this comment

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

I checked the use of curies. this way it is correct. The curie type is from the SAMM meta model.

Copy link
Contributor

@bs-jokri bs-jokri left a comment

Choose a reason for hiding this comment

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

Model LGTM


All notable changes to this model will be documented in this file.

## [1.0.0]
Copy link
Contributor

Choose a reason for hiding this comment

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

don't forget to add the date of the MS3 approval to the RELEASE_NOTES once it is MS3 approved

@github-actions
Copy link

Validation Report for io.catenax.shared.shopfloor_information_types/1.0.0/ShopfloorInformationTypes.ttl

Validation failed:

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

MS2 approval given with the condition that the model io.catenax.message_header:1.0.0 is released (otherwise model cannot validate)

@bosserf
Copy link

bosserf commented Jul 17, 2023

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) -> OK
The new aspect (version) will be implemented by at least one data provider -> OK
The new aspect (version) will be consumed by at least one data consumer -> OK
There exists valid test data -> OK
In case of a new (incompatible) major version to an existing version, a migration strategy has been developed -> doesn't apply
The model has at least version '1.0.0' -> OK
The release date in the Release Note is set to the date of the MS3 approval -> has to be done

@bosserf
Copy link

bosserf commented Jul 17, 2023

MS3: approval given with the condition that the model io.catenax.message_header:1.0.0 is released (otherwise model cannot validate)
otherwise approved by group

update message header prefix to shared namespace
@github-actions
Copy link

github-actions bot commented Aug 4, 2023

Validation Report for io.catenax.shared.shopfloor_information_types/1.0.0/ShopfloorInformationTypes.ttl

Validation failed:

@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 Sep 4, 2023
@github-actions
Copy link

github-actions bot commented Sep 4, 2023

Validation Report for io.catenax.shared.shopfloor_information_types/1.0.0/ShopfloorInformationTypes.ttl

Validation failed:

@bs-jokri bs-jokri merged commit ef88d64 into eclipse-tractusx:main Sep 4, 2023
3 checks passed
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.

4 participants