co-cddo / ukgov-metadata-exchange-model

A metadata model for describing data assets for exchanging between UK government organisations.
https://co-cddo.github.io/ukgov-metadata-exchange-model/
Other
13 stars 1 forks source link

Launch Release Management to lock the existing spec and start formal Change Management process and versioning workflow #70

Open cyberdudeuk opened 11 months ago

cyberdudeuk commented 11 months ago

Is your feature request related to a problem? Please describe. The current Metadata Exchange Model is an evolution of the original Minimum Metadata Requirements specification baselined at the end of Jan 2023. It contains a subset of the original requirements focussed on those needed to power/enable discovery of data assets (ESDAs) in the Government Data Marketplace.

The current backlog is made up of some issues that refer to minor tweaks in the existing spec such as adding usage notes to some properties taht currenlty lack them and add additional information on some existing ones.

There are already 4 new requirements to extend the specification, however they are currently on hols until we issue a first release to lock teh current version and use the next release to implement the new requirements submitted and those that will arise in the course of implementing the Marketplace.

Describe the solution you'd like Launch a pre/new release of the current version, move any new requirements to the next release.

cyberdudeuk commented 11 months ago

Hi @RobNicholsGDS can we pls have a chat to agree how we go about this?

RobNicholsGDS commented 11 months ago

First release v0.1.0 created

AlasdairGray commented 11 months ago

When making a release, I'm not sure that providing a zip of the repo is the most helpful. We should be publishing the model definition in the generated formats:

These are generated when you run make test

It may also be useful to supply user documentation alongside them.

RobNicholsGDS commented 10 months ago

The zip is autogenerated by Github on release creation. I don't think it is something that we can switch off.

AlasdairGray commented 10 months ago

Not a problem if they are there as well since they would allow someone to build the release model, but probably best if we include the models alongside.