Skip to content

Conversation

@fdiblen
Copy link
Member

@fdiblen fdiblen commented Apr 29, 2021

Fixes #235

Important Note:
Please use https://sandbox.zenodo.org/ instead of https://www.zenodo.org/ to test the instructions otherwise entry you create on Zenodo cannot be removed easily.

Summary
This pull request adds an issue template for Zenodo integration.

Testing

  • Create a new package
  • Push the package to GitHub
  • Check the generated issue about Zenodo integration
  • Follow the instructions on https://sandbox.zenodo.org/

@sverhoeven sverhoeven self-requested a review May 3, 2021 07:12
Copy link
Member

@sverhoeven sverhoeven left a comment

Choose a reason for hiding this comment

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

Instructions work, tested it against Zenodo sandbox and Zenodo record was created.

The Next step: Citation data issue asks you to create a .zenodo.json file which could cause change in Zenodo record in next release. For example my Zenodo record title is sverhoeven/justatest: v0.1.0 instead of justatest.
Should we change the order and make Next step: Zenodo integration issue depend on Next step: Citation data issue?

The instructions uses the versioned DOI instead of the concept/latest DOI. Should we prefer the concept DOI?


1. Go to http://zenodo.org and login with your GitHub account. When you are redirected to GitHub, *Authorize application* to give permission to Zenodo to access your account.
1. Go to <https://zenodo.org/account/settings/github/> and enable Zenodo integration of your repository by clinking on `On` toggle button.
1. Your package will get a DOI only after you make a release. Create a new release on <{{cookiecutter.repository}}/releases/new>
Copy link
Member

Choose a reason for hiding this comment

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

Can we point to README.dev.md#33-github instead of {{cookiecutter.repository}}/releases/new?

Copy link
Member

Choose a reason for hiding this comment

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

Also link is broken as it renders as </releases/new>, but will be fixed in #261

Copy link
Member Author

Choose a reason for hiding this comment

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

updated the link

@jspaaks
Copy link

jspaaks commented May 3, 2021

Should we change the order and make Next step: Zenodo integration issue depend on Next step: Citation data issue?

Yes

@jspaaks
Copy link

jspaaks commented May 3, 2021

The instructions uses the versioned DOI instead of the concept/latest DOI. Should we prefer the concept DOI?

Yes

@fdiblen
Copy link
Member Author

fdiblen commented May 3, 2021

Instructions work, tested it against Zenodo sandbox and Zenodo record was created.

The Next step: Citation data issue asks you to create a .zenodo.json file which could cause change in Zenodo record in next release. For example my Zenodo record title is sverhoeven/justatest: v0.1.0 instead of justatest.
Should we change the order and make Next step: Zenodo integration issue depend on Next step: Citation data issue?

The instructions uses the versioned DOI instead of the concept/latest DOI. Should we prefer the concept DOI?

Thanks for suggesting this. I have changed the order.

@fdiblen fdiblen requested a review from sverhoeven May 3, 2021 11:36
Copy link
Member

@sverhoeven sverhoeven left a comment

Choose a reason for hiding this comment

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

Looking good. Just one major inline suggestion about concept DOI and some typo corrections.

fdiblen and others added 6 commits May 3, 2021 14:34
…egration.md

Co-authored-by: Stefan Verhoeven <stefan.verhoeven@gmail.com>
…egration.md

Co-authored-by: Stefan Verhoeven <stefan.verhoeven@gmail.com>
…egration.md

Co-authored-by: Stefan Verhoeven <stefan.verhoeven@gmail.com>
…egration.md

Co-authored-by: Stefan Verhoeven <stefan.verhoeven@gmail.com>
@fdiblen fdiblen requested a review from sverhoeven May 3, 2021 12:37
sverhoeven added a commit that referenced this pull request May 3, 2021
Copy link
Member

@sverhoeven sverhoeven left a comment

Choose a reason for hiding this comment

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

LGTM

@fdiblen fdiblen merged commit c8e1e52 into main May 3, 2021
@fdiblen fdiblen deleted the 235-zenodo-integration branch May 3, 2021 13:09
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.

add issue template about zenodo integration

4 participants