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

MRG, MAINT: add codemeta #8669

Merged
merged 14 commits into from
Jan 4, 2021
Merged

MRG, MAINT: add codemeta #8669

merged 14 commits into from
Jan 4, 2021

Conversation

drammock
Copy link
Member

@drammock drammock commented Dec 17, 2020

Boilerplate was generated using https://codemeta.github.io/codemeta-generator/ and the things that might change (release date, release version, dependencies, and authors) are update by the new script tools/generate_codemeta.py which can be run at release time.

@larsoner
Copy link
Member

The authors look like something that could be easily scripted except for the ORCID ID.

@drammock drammock marked this pull request as ready for review December 23, 2020 19:17
@drammock drammock changed the title add codemeta MAINT: add codemeta Dec 23, 2020
@drammock drammock changed the title MAINT: add codemeta MRG, MAINT: add codemeta Dec 23, 2020
@drammock
Copy link
Member Author

CIs all green, ready for review/merge

Copy link
Member

@larsoner larsoner left a comment

Choose a reason for hiding this comment

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

Have some ideas for making things more DRY/reduce number of steps this adds to our processes.

Also can you write a corresponding line in the wiki for making a release for example:

4. PENDING PR 8669: Check `tools/generate_codemeta.py` against new names in `doc/changes/latest.inc` for compound surnames, then run `tools/generate_codemeta.py` to update `codemeta.json`

Choosing the number/location based on probably needing to come after changing the version, but before pushing a commit, and before making the GitHub release? I think this plus my inline suggestions would reduce the "added effort" to support this to be ~1 minute during the "making a release" stage, which would be great!

@drammock
Copy link
Member Author

CIs all green again, ready for second review.

Copy link
Member

@larsoner larsoner left a comment

Choose a reason for hiding this comment

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

So the only thing we have to do from now on (other than make sure this code still works) is, during release:

  1. Edit tools/generate_codemeta.py to update the compound_surnames variable (if needed, based on new contributors from the changelog). Then from the tools folder run python generate_codemeta.py to update the codemeta metadata for this release.

Sounds easy enough to me, +1 for merge

@drammock

This comment has been minimized.

@drammock
Copy link
Member Author

OK, local testing in an env using mne-stable seems to work correctly now. after running it I manually back-dated the dateModified field to the release date of 0.22, but when doing actual releases this should not be necessary.

Copy link
Member

@agramfort agramfort left a comment

Choose a reason for hiding this comment

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

thanks @drammock ! merge if good to go from your end

@drammock drammock merged commit 415ae68 into mne-tools:master Jan 4, 2021
@drammock drammock deleted the add-codemeta branch January 4, 2021 13:19
cbrnr pushed a commit to cbrnr/mne-python that referenced this pull request Jan 15, 2021
* add codemeta.json (metadata)

* update mailmap

* add generator script

* regen JSON

* remove leading newline

* cleaner; better comments

* exclude codemeta from manifest

* safer check

* better comments, automate downloadUrl

* clearer variable names

* regen JSON

* DRY dependency versions; changes from Eric's review

* fix path

* regen metadata
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.

3 participants