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

Update codemeta.json for version 0.4.0 and related release guide instructions #902

Merged
merged 10 commits into from
Sep 24, 2020

Conversation

namurphy
Copy link
Member

Codemeta is an emerging open metadata standard for storing information about software packages. This PR updates our codemeta.json file to be consistent with our version 0.4.0 release, and also adds the author list. I'm hoping this will (eventually) alleviate some of the tedious aspects of uploading releases to Zenodo.

One continual worry though is that we have some of the same data in different places that will need to be updated simultaneously during releases. I'm wondering if we could generate the author list that goes in the documentation from codemeta.json, or do other similar things. But, that's for another day (or more likely, for another year).

This field is might not be able to be updated before the release is
uploaded to PyPI or Zenodo.  The DOI makes it findable enough anyway.
@codecov
Copy link

codecov bot commented Sep 23, 2020

Codecov Report

Merging #902 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #902   +/-   ##
=======================================
  Coverage   96.21%   96.21%           
=======================================
  Files          60       60           
  Lines        5414     5414           
=======================================
  Hits         5209     5209           
  Misses        205      205           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 02d38c5...2b963f9. Read the comment docs.

 - Add newer versions of Python
 - Remove google group as email address of developers
@StanczakDominik
Copy link
Member

So I guess .zenodo.json got obsoleted by... what? Does zenodo parse codemeta.json now?

Copy link
Member

@StanczakDominik StanczakDominik left a comment

Choose a reason for hiding this comment

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

LGTM, a few minor questions/comments:

codemeta.json Outdated
"@type": "SoftwareSourceCode",
"license": "https://spdx.org/licenses/BSD-2-Clause-Patent",
"codeRepository": "https://github.com/PlasmaPy/plasmapy",
"contIntegration": "https://dev.azure.com/plasmapy/PlasmaPy/_build/results?buildId=1733&view=results",
Copy link
Member

Choose a reason for hiding this comment

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

Do we want this to point to that particular build (PR 900)?

Copy link
Member Author

Choose a reason for hiding this comment

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

And this, my friend, is why we do code review!

"identifier": "http://doi.org/10.5281/zenodo.4037407",
"description": "An open source Python package for plasma research and education",
"applicationCategory": "Plasma Physics",
"developmentStatus": "wip",
Copy link
Member

Choose a reason for hiding this comment

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

very wip

codemeta.json Outdated Show resolved Hide resolved
Co-authored-by: Dominik Stańczak <[email protected]>
@namurphy
Copy link
Member Author

namurphy commented Sep 24, 2020

So I guess .zenodo.json got obsoleted by... what? Does zenodo parse codemeta.json now?

If I'm remembering correctly, .zenodo.json is an experimental feature that never became part of the Zenodo API and never had sufficient documentation anyway. I don't think I've gotten it to work...though in retrospect maybe it was because the Zenodo uploads included .zenodo.json in the zip file, so that .zenodo.json wasn't at the top level. Zenodo doesn't parse codemeta files yet, I don't think, but I'm expecting it to in the future.

Cross-reference: #628, zenodo/zenodo#1504, codemeta/codemeta#213

@namurphy namurphy merged commit 0ed31b1 into PlasmaPy:master Sep 24, 2020
@namurphy namurphy deleted the update-codemeta-post0_4_0 branch August 14, 2021 13:03
@namurphy namurphy added the release Related to releasing a new version of PlasmaPy label May 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor guide release Related to releasing a new version of PlasmaPy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants