Skip to content

Comments

Minimal post-processing step#175

Merged
poikilotherm merged 18 commits intodevelopfrom
feature/174-post-processing
May 22, 2023
Merged

Minimal post-processing step#175
poikilotherm merged 18 commits intodevelopfrom
feature/174-post-processing

Conversation

@led02
Copy link
Member

@led02 led02 commented May 8, 2023

  • Provide deposition result for later steps using the cache
  • Feed back information from deposition result ... somewhere

@led02 led02 added this to the Proof-of-concept milestone May 8, 2023
@led02 led02 linked an issue May 8, 2023 that may be closed by this pull request
@led02 led02 marked this pull request as ready for review May 11, 2023 14:44
@led02 led02 requested review from poikilotherm and sdruskat May 11, 2023 14:44
Copy link
Contributor

@sdruskat sdruskat left a comment

Choose a reason for hiding this comment

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

Thanks @led02!

Looks good to me so far.

I've changed to use the default YAML loader instead of CLoader in b88367b and re-worked CFF updating quite a bit in 51fd2bb. Please review carefully!

Notes on CFF updating:

  • CFF doesn't (yet) have DataCite-like relations for identifiers, so this will append rather than re-write the new identifier to a (perhaps already existing) list of identifiers. I refrained from doing too much string diffing to detect previous versions, etc. This can be re-worked and made much better once CFF has the relations between identifiers implemented.
  • Like I said, identifier overwrites are switched off now.
  • The identifier description has been updated to include the version number from the deposit metadata, so that human users (for whom the description is) know what they are looking at. Ideally, we'd remove identifiers for older versions, but this isn't easily doable now without extra calls to the Invenio API.

cff = yaml.load(open('CITATION.cff', 'r'), yaml.CLoader)
cff['identifiers'] = [
{
'description': "Generated by hermes after deposition.",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
'description': "Generated by hermes after deposition.",
'description': f"DOI for the published version {deposition['metadata']['version']} [generated by hermes]",

polish: Better describe the value of the identifier, use square brackets for easier data mining later.

@sdruskat sdruskat requested review from zyzzyxdonta and removed request for poikilotherm May 15, 2023 14:20
@sdruskat
Copy link
Contributor

@zyzzyxdonta Please feel free to give this a quick review as well.

sdruskat and others added 2 commits May 15, 2023 16:37
Co-authored-by: Stephan Druskat <sdruskat@users.noreply.github.com>
sdruskat and others added 3 commits May 22, 2023 11:00
Copy link
Member

@poikilotherm poikilotherm left a comment

Choose a reason for hiding this comment

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

We have seen in the showcase testing this addition is very valuable and works without flaws so far. Ship it! :shipit:

@poikilotherm poikilotherm merged commit 395c10a into develop May 22, 2023
@poikilotherm poikilotherm deleted the feature/174-post-processing branch May 22, 2023 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Minimal post processing example

5 participants