Skip to content

Integrate the prepared sales2018competition update #199

Description

@pedropaulofb

Objective

Integrate the author-provided update for sales2018competition into the current catalog structure.

The prepared update is available in the repository branch:

update-sales2018competition

at:

sales2018competition/

The current catalog dataset is available on master at:

models/sales2018competition/

This is therefore an integration and migration task. The update source does not need to be recovered.

Authoritative inputs

Use the following as the comparison inputs:

Current catalog dataset

master:models/sales2018competition/

Prepared author-provided update

update-sales2018competition:sales2018competition/

The prepared branch contains an explanatory README.txt, the original diagram material, and other reusable files. Read and preserve the relevant instructions and provenance recorded there.

Do not merge the historical branch wholesale. Its dataset must be migrated into the repository’s current directory structure, metadata model, generation tooling, and validation workflow.

Phase 1: inventory the prepared update

Record every file available under:

update-sales2018competition:sales2018competition/

For each file, classify it as:

  • canonical editable model;
  • original diagram;
  • newly generated diagram;
  • model serialization;
  • descriptive metadata;
  • distribution metadata;
  • bibliography or source reference;
  • explanatory documentation;
  • obsolete generated artifact;
  • other supporting material.

Read README.txt and extract:

  • the reported problems with the catalog version;
  • the intended semantic changes;
  • the provenance of the replacement material;
  • any instructions from the model author;
  • any limitations or unresolved questions.

Phase 2: compare the models

Compare the current catalog model with the prepared update.

At minimum, inspect:

  • packages and diagrams;
  • classes;
  • OntoUML stereotypes;
  • generalizations;
  • associations;
  • association stereotypes;
  • association ends;
  • multiplicities;
  • aggregations and compositions;
  • attributes;
  • constraints;
  • notes and definitions;
  • deleted, renamed, and added model elements.

Classify every difference as:

  • semantic model correction;
  • semantic model extension;
  • terminology or naming correction;
  • diagram or layout-only change;
  • identifier or serialization-only difference;
  • metadata or provenance update;
  • obsolete generated-file difference.

The pull request must summarize the substantive differences rather than merely replacing the files.

Phase 3: migrate the accepted update

After confirming the prepared branch represents the intended authoritative revision:

  • update models/sales2018competition/ontology.vpp;
  • regenerate ontology.json;
  • regenerate ontology.ttl;
  • migrate or regenerate the required diagrams;
  • preserve authoritative original diagrams from the update branch;
  • update the canonical metadata.yaml;
  • update references.bib;
  • regenerate model and distribution metadata;
  • synchronize catalog.ttl;
  • remove files that belong only to the historical repository structure;
  • ensure no generated artifact from the old branch is copied without regeneration or validation.

The dataset identifier should remain sales2018competition unless the comparison demonstrates that the prepared model represents a materially different ontology.

Metadata review

Verify and complete:

  • title;
  • acronym, when applicable;
  • creators and contributors;
  • issued and modified dates;
  • authoritative publications;
  • provenance;
  • landing page;
  • license;
  • keywords;
  • ontology type;
  • representation style;
  • editorial note describing the update when useful.

Do not change the model’s semantic modification date solely because generated files or metadata were migrated.

Validation

Run the current repository checks for:

  • canonical metadata;
  • bibliography;
  • JSON validity;
  • Turtle generation and parsing;
  • model and distribution metadata;
  • diagram distributions;
  • catalog synchronization;
  • model-submission structure.

The update pull request must contain only the current dataset directory and any directly required catalog-level generated changes. It should not preserve the historical branch layout.

Completion criteria

  • The prepared branch and README.txt have been reviewed.
  • All prepared files have been inventoried.
  • The prepared model has been compared with the current catalog model.
  • Semantic differences have been documented.
  • Accepted model changes have been migrated into models/sales2018competition/.
  • Canonical metadata and references have been updated.
  • All derived artifacts have been regenerated using current tooling.
  • Original diagrams and provenance have been preserved where applicable.
  • Repository validation passes.
  • The update pull request has been reviewed and merged.

Close this issue as completed after the migrated update has been merged into master.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    update modelUpdate, upgrade, correct, or modify a dataset (model)

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions