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

Datacite xml improvements #10615

Closed

Conversation

qqmyers
Copy link
Member

@qqmyers qqmyers commented Jun 5, 2024

Note - this is a subset of the changes in #10632 / #10632 adds relatedPublication relationType in addition to updating the XML sent to DataCite as described here. Nominally only #10632 needs to be merged, but this could be merged first to make it easier to see just the relationType changes in #10632.

What this PR does / why we need it: This PR updates the XML sent to DOI providers to be richer and more consistent with what is in the OpenAire export. There are differences (most obviously, the code here works for draft datasets and files which are not handled by the OpenAire exporter), most are probably subtle but @jggautier or others may wish to look at/comment on the list of changes I've tried to track in this doc.

This is nominally one of 2 PRs related to DOI metadata - the other will be a change to the citation metadatablock to add a relationshipType to the field(s) where we expect to report the relationships to DataCite/etc.

Which issue(s) this PR closes:
Probably closes #5889 when combined with the relationshipType PR.
Closes #

Special notes for your reviewer: The PR includes some refactoring of our XML generation code that is common with the DDI export. @poikilotherm's idea of generating a model from the DataCite schema might be a good next step (hopefully easier given the code here to get the content needed).

Suggestions on how to test this: QDR is testing this code now. There is one new test in addition to the existing ones - it could/should be expanded to test a dataset with more of the metadata that is covered by the new code - possibly just reading in one of the ~complete dataset examples we have. Verification that the result matches the DataCite schema is included.

Does this PR introduce a user interface change? If mockups are available, please link/include them here: only changes the XML sent to the DOI provider which is also exposed as a metadata export. The change makes the OpenAire export somewhat redundant, but as noted above, there are differences which may need to be kept.

Is there a release notes update needed for this change?: yes - will create once the set of changes (in the doc above) is reviewed. Probably should be combined with the citation block change if that can be created in time for the same release.

Additional documentation:

@coveralls
Copy link

coveralls commented Jul 19, 2024

Coverage Status

coverage: 20.953% (+0.2%) from 20.735%
when pulling 561fd2c on QualitativeDataRepository:datacite_xml_improvements
into 4143031 on IQSS:develop.

@qqmyers qqmyers added the Size: 3 A percentage of a sprint. 2.1 hours. label Jul 21, 2024
@qqmyers qqmyers marked this pull request as ready for review July 21, 2024 17:30
@qqmyers qqmyers added GDCC: QDR of interest to QDR Consider For Next Release A simple change (eg bug fix) that would be good to prioritize since it has been seen in the wild labels Jul 21, 2024
@DS-INRA
Copy link
Member

DS-INRA commented Jul 22, 2024

Another related issue (probably already taken into account since it's on the QDR board :) but just in case) :

@pdurbin
Copy link
Member

pdurbin commented Jul 29, 2024

Just a heads up that I'm tasked with sending "Software" etc in another issue and I can only assume it will cause merge conflicts if we merge my PR first. Here's the commit: 8593d32

@pdurbin
Copy link
Member

pdurbin commented Sep 6, 2024

@qqmyers can you please resolve merge conflicts?

@qqmyers qqmyers removed their assignment Sep 6, 2024
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

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

Needs a release note

@@ -1123,4 +1123,23 @@ private boolean tagExists(String tagLabel) {
}
Copy link
Member

Choose a reason for hiding this comment

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

I'll just leave this comment here on the first file that is changed...

Can we please get a release note?

@cmbz cmbz added Status: Waiting for Related Issues/PRs This issue depends upon the completion of one or more issues/PRs FY25 Sprint 6 FY25 Sprint 6 labels Sep 11, 2024
@qqmyers
Copy link
Member Author

qqmyers commented Sep 16, 2024

Closing in favor of #10632, which now has some bug fixes in the XML that haven't been back-ported to this PR.

@qqmyers qqmyers closed this Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Consider For Next Release A simple change (eg bug fix) that would be good to prioritize since it has been seen in the wild FY25 Sprint 5 FY25 sprint 5 FY25 Sprint 6 FY25 Sprint 6 GDCC: QDR of interest to QDR GREI 2 Consistent Metadata Size: 3 A percentage of a sprint. 2.1 hours. Status: Waiting for Related Issues/PRs This issue depends upon the completion of one or more issues/PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Align or merge DataCite metadata exports
6 participants