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

io.catenax.parts_analyses:1.0.0: Set to deprecation #177

Conversation

TorstenHirsch
Copy link
Contributor

@TorstenHirsch TorstenHirsch commented May 16, 2023

Set old model version to deprecated

Description

With feature request 162 the new model version PartsAnalyses:2.0.0 will be released.
The old/current version has missing properties that makes it impossible to merge the data with e.g. data from ProductDescription semantic model.
Request is to set currrent model to deprecated.

-->

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 "name" and "description" in English language.
  • no duplicate names or preferredNames within an Aspect (e.g. a 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"
  • 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'

set old model version to deprecated
@TorstenHirsch
Copy link
Contributor Author

Modelling_Team

@TorstenHirsch TorstenHirsch changed the title Update metadata.json io.catenax.parts_analyses:1.0.0: Set to deprecation after releasing io.catenax.parts_analyses:2.0.0 May 16, 2023
@TorstenHirsch TorstenHirsch changed the title io.catenax.parts_analyses:1.0.0: Set to deprecation after releasing io.catenax.parts_analyses:2.0.0 io.catenax.parts_analyses:1.0.0: Set to deprecation May 16, 2023
@bs-jokri bs-jokri added the MS2_Approved Checklist "MS2 Valid Model" is approved. label May 17, 2023
{ "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.

@bs-jokri is it deprecated or deprecate?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I now changed the information in metadata file to deprecate

@catroest
Copy link
Contributor

add issue link, so the issue will be closed after the merge

updated metadata.json: chnge deprecated to deprecate
@TorstenHirsch
Copy link
Contributor Author

#modeling_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 Jun 26, 2023
@bs-jokri bs-jokri merged commit 9c03a60 into eclipse-tractusx:main Jun 26, 2023
@TorstenHirsch TorstenHirsch deleted the feature-162-Set-old-model-version-to-deprecated branch November 10, 2023 13:53
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