-
Notifications
You must be signed in to change notification settings - Fork 33
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
Start to add codemeta.json #324
Start to add codemeta.json #324
Conversation
If you need more details, or have any other questions, you might consider waiting until Monday's Group Meeting. I have allocated a short slot there. |
codemeta.json
Outdated
"familyName": "Nicolas Winckler", | ||
"affiliation": { | ||
"@type": "Organization", | ||
"name": "Bull-Atos" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How is this meant to be updated/maintained when someone's affiliation changes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- I'll take that question to the next ESCAPE meeting. Seems interesting genereally.
- First quick answer: The same as on zenodo: Find someone to update it. Not very scalable.
- Also maybe the meaning is "The affiliation that person had, when working on the project"? I'll try to figure that out.
- One possible way around this: Don't add an affiliation. Just add an ORCID. You can update your own ORCID.
@dennisklein function(get_codemeta_version)
if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.19)
file(READ "${CMAKE_SOURCE_DIR}/codemeta.json" codemeta_content)
string(JSON codemeta_version GET "${codemeta_content}" "version")
string(REGEX REPLACE "^v" "" codemeta_version "${codemeta_version}")
set(PROJECT_CODEMETA_VERSION "${codemeta_version}" PARENT_SCOPE)
endif()
endfunction() If you're interested, we can improve that code and include it in this PR? This also works nicely: -get_git_version()
+get_codemeta_version()
+get_git_version(DEFAULT_VERSION "${PROJECT_CODEMETA_VERSION}") |
278b80a
to
429ce00
Compare
@ChristianTackeGSI Could you post the list of codemeta keys we discussed last week we want to support, then I can take over from here. Thx! |
I will force-push maybe tomorrow or Wednesday with an updated codemeta.json, a (python based) tool to update codemeta.json from AUTHORS and CONTRIBUTORS (and version). I will also include a bit of cmake to read the version from codemeta.json (for the dist tarballs). I hope that will be a good point for you to continue then. Let's see. |
codemeta.json is becoming a standard format for describing software. Let's start to add it. This version represents the old data on zenodo.
These are the fields, that we actually want in there. All the other fields should be generated by a tool.
This tool can take the data from AUTHORS and CONTRIBUTORS and merge it into the appropriate codemeta.json sections. This is really a merge: If things already exist, they will be updated.
Small tool for release tarballs to read the current version from the codemeta.json.
429ce00
to
660fcb9
Compare
@dennisklein Okay, updated some stuff.
|
cherry-picked in #363 |
codemeta.json is becoming a standard format for describing software. Let's start to add it.
This is also starting to get relevant in the context of ESCAPE.
I created the current codemeta.json to match the entry on zenodo as closely as possible. That means, that any issues with the zenodo entry are also issues with the codemeta data.
Notes:
github lists it as LGPL-3.0
I have set it to "LGPL-3.0-or-later".
If that's correct, please consider updating zenodo.
If that's wrong, please fix codemeta.json (possibly in a new commit, possibly by letting me
git commit --amend
), and fix zenodo.Helpful:
You can even paste the suggested codemeta.json there and view it.
Checklist:
dev
branch