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] shopfloor_information_types #551

Merged
merged 9 commits into from
Jan 31, 2024
Merged

[Model Update] shopfloor_information_types #551

merged 9 commits into from
Jan 31, 2024

Conversation

FlorianDue
Copy link
Contributor

@FlorianDue FlorianDue commented Jan 24, 2024 •
edited by agg3fe
Loading

Description

Update of the Message_header to the latest version

-->

Closes #535

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

@agg3fe
Copy link
Contributor

agg3fe commented Jan 25, 2024

@FlorianDue v1.0.0 does not have any artifacts in it. do you want to deprecate 1.0.0?

agg3fe
agg3fe reviewed Jan 25, 2024
View reviewed changes
io.catenax.shared.shopfloor_information_types/2.0.0/ShopfloorInformationTypes.ttl Outdated
@prefix : <urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#> .
@prefix ext-header: <urn:samm:io.catenax.shared.message_header:2.0.0#> .

:ShopfloorInformationTypes a samm:Aspect ;
Copy link
Contributor

Choose a reason for hiding this comment

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

any reason for making aspect name plural? it does not have any List/Set as root element.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The defined aspect is a shared aspect that is not used by us. However the namespace features two types that we re-use in our other models:

the property communicationMode, and the TimeValueCharacteristic. Thats the reason for the plural.

If the plural is still a problem i can also change it to singular, Would that change also mean that we have to update the name of our namespace to io.catenax.shared.shopfloor_information_type ?

Copy link
Contributor

Choose a reason for hiding this comment

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

understood. then let's keep it plural.

agg3fe
agg3fe reviewed Jan 25, 2024
View reviewed changes
io.catenax.shared.shopfloor_information_types/2.0.0/ShopfloorInformationTypes.ttl Outdated
:IntegerValueCharacteristic a samm:Characteristic ;
samm:preferredName "Integer Value Characteristic"@en ;
samm:description "The value of the specified timeUnit as an integer value"@en ;
samm:dataType xsd:integer .
Copy link
Contributor

Choose a reason for hiding this comment

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

please remove unnecessary spaces from end.

agg3fe
agg3fe requested changes Jan 25, 2024
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.

please check my comments

agg3fe
agg3fe reviewed Jan 25, 2024
View reviewed changes
io.catenax.shared.shopfloor_information_types/2.0.0/ShopfloorInformationTypes.ttl Outdated
#
# SPDX-License-Identifier: CC-BY-4.0
##########################################################################################
@prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.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.

please change to samm metamodel 2.1.0

@FlorianDue
Copy link
Contributor Author

Thank you for your feedback!

I just pushed the latest version where I set the samm metamodel to 2.1.0, removed the spaces at the end and set version 1.0.0 to deprecated.

Looking forward to your feedback!

agg3fe
agg3fe reviewed Jan 26, 2024
View reviewed changes
io.catenax.shared.shopfloor_information_types/1.0.0/metadata.json Outdated
@@ -1 +1 @@
{ "status" : "release" }
{ "status" : "deprecated" }
Copy link
Contributor

Choose a reason for hiding this comment

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

it should be deprecate and not deprecated. please make sure this is not in use before deprecating it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok, then i have a question, what should be set for the metadata.json. I expected that i should be deprecate, since we are publishing version 2.0.0. However, if possible, keep version 1.0.0. SO what do i have to then write into the status?

Copy link
Contributor

Choose a reason for hiding this comment

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

then you don't need to change anything in status. you can keep it release like before and revert the changes. Let's deprecate it later on.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for your fast replay, i reverted it to release and pushed the latest version

agg3fe
agg3fe approved these changes Jan 26, 2024
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

@github-actions GitHub Actions
Copy link

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

Input model is valid

@github-actions GitHub Actions
Copy link

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

Input model is valid

@agg3fe agg3fe added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Jan 26, 2024
@FlorianDue FlorianDue mentioned this pull request Jan 26, 2024
Merged
28 tasks
@agg3fe agg3fe added the MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br label Jan 29, 2024
@github-actions GitHub Actions
Copy link

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

Input model is valid

@github-actions GitHub Actions
Copy link

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

Input model is valid

@agg3fe agg3fe merged commit d4dd268 into eclipse-tractusx:main Jan 31, 2024
4 checks passed
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]: ShopfloorInformationTypes
2 participants
@FlorianDue @agg3fe