search

International-Data-Spaces-Association / InformationModel

The Information Model of the International Data Spaces implements the IDS reference architecture as an extensible, machine readable and technology independent data model.
Apache License 2.0
64 stars 37 forks source link

Create and follow check list for future releases #381

Closed clange closed 2 years ago

clange commented 3 years ago

For any future release, the following steps should be followed. First of all, these steps should be documented in a central place, and then we should copy them as a check list to an issue or to the pull request for merging the changes for the new revision into the master branch. Please edit this issue's description to make it complete.

  1. provide complete validation shapes for the new ontology terms; remove shapes for the old ones
  2. create upgrade shapes from the previous revision to the new one
  3. update and validate, against the shapes, the examples to use the latest ontology version
  4. generate human-readable documentation and single-file serializations using Widoco
  5. make sure that the manually authored parts of the documentation (including the human-readable description of the examples) are in sync with the rest of the implementation and documentation
  6. update the message table
  7. generate Java library
  8. update changelog
JohannesLipp commented 3 years ago

Note that the first bullet might be solved/supported by #147

JohannesLipp commented 3 years ago
  1. Is triggered manually currently, and the output must be pushed to the gh-pages branch for automatic synchronization. We will investigate whether an automatic trigger is helpful.
JohannesLipp commented 3 years ago

One addition to point 8: Inform Plugfest member about new features in time, so that they can be discussed before publishing.

HaydarAk commented 2 years ago

Addition:

JohannesLipp commented 2 years ago

Solved