Schema 4.5

[KellyStathis]

Purpose

Update to schema version 4.5.

Approach

Directory structure

• Schema updates are in the kernel-4 directory (source/meta/kernel-4). For review, please look at kernel-4 to see the diff.
• Changes are also included in a new kernel-4.5 directory, as we always include the latest version by minor version number as well. To avoid making changes in two places, kernel-4 should be the focus of review and changes; at the end, the contents of kernel-4 should be copied to kernel-4.5 to ensure they match.

  Changes

• Changes follow the schema documentation produced by the Metadata WG, see Version Update for 4.5.
  • Schema: Updated metadata.xsd to address changes to Publisher property and new Distribution property
  • Controlled lists: Added controlled list values to resourceTypeGeneral and relationType
• Corresponding website updates for schema 4.5 are also included.

Open Questions and Pre-Merge TODOs

• [ ] Update release date in:

  • [ ] https://github.com/datacite/schema/blob/schema-4.5/source/_four.html.md.erb
  • [ ] https://github.com/datacite/schema/blob/schema-4.5/source/meta/kernel-4/index.html.md
  • [ ] https://github.com/datacite/schema/blob/schema-4.5/source/meta/kernel-4/metadata.xsd

• [ ] Change DOIs for schema documentation and schema to Findable state (currently in Draft)

• [ ] Copy contents of kernel-4 directory to new kernel-4.5 directory.

• [ ] Examples

  • [x] Finalize examples
  • [ ] Change path in examples from ../metdata.xsd to URL path
  • [ ] Confirm what to do with <identifier> field for these examples (prefix, registering test DOI, etc)
  • [ ] Add JSON examples

• [ ] Determine if we can fix any of the following issues as part of this release (these are not yet included in the PR)

  • [ ] https://github.com/datacite/datacite/issues/1748
  • [ ] https://github.com/datacite/datacite/issues/1709
  • [ ] https://github.com/datacite/datacite/issues/1653

Learning

Types of changes

• [ ] Bug fix (non-breaking change which fixes an issue)

• [x] New feature (non-breaking change which adds functionality)

• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Reviewer, please remember our guidelines:

• Be humble in the language and feedback you give, ask don't tell.
• Consider using positive language as opposed to neutral when offering feedback. This is to avoid the negative bias that can occur with neutral language appearing negative.
• Offer suggestions on how to improve code e.g. simplification or expanding clarity.
• Ensure you give reasons for the changes you are proposing.

[KellyStathis]

I think the /specs for 4.5 are missing. This is basically testing the XSD against examples. Check the specs folder, that is missing. Test are important and show we are being through in the revision and assure backwards compatibility. But one needs the examples to run the specs.

Thanks for this @kjgarza. I can provide the examples shortly, but I'm not sure how to update the .rb tests themselves. I think this might need to fall under the 4.5 implementation.

As a note, we will also be changing the examples and reducing the number of full examples that are maintained by the MWG (see: https://github.com/datacite/metadata-wg/discussions/15)

[kjgarza]

I think if you duplicate the whole folder and change the references to 4.5 you would at least cover backwards compatibility and the new elements and properties will be the only that will need extra work

[KellyStathis]

@kjgarza Most of the example files are changing and some are being removed, so I think it will need a little more work to update than just changing references—unless we want to point back to some of the 4.4 examples for testing against the 4.5 schema?

[KellyStathis]

I added to the "open questions and pre-merge todos" the question about bug fixes. I think of these, https://github.com/datacite/datacite/issues/1709 is the most feasible because RelatedItem (and this bug) was only introduced in 4.4. The other two have existed for longer and we need to ensure changes are backwards compatible.