From 763780627c50cb4813d0a9d35041f4799ff73f06 Mon Sep 17 00:00:00 2001 From: Faruk D Date: Thu, 29 Apr 2021 16:15:26 +0200 Subject: [PATCH 1/9] add Zenodo integration issue template --- .../next_steps/02_zenodo_integration.md | 21 +++++++++++++++++-- {{cookiecutter.project_name}}/README.dev.md | 5 ++--- 2 files changed, 21 insertions(+), 5 deletions(-) diff --git a/{{cookiecutter.project_name}}/.github/next_steps/02_zenodo_integration.md b/{{cookiecutter.project_name}}/.github/next_steps/02_zenodo_integration.md index 310f17e9..76857dc2 100644 --- a/{{cookiecutter.project_name}}/.github/next_steps/02_zenodo_integration.md +++ b/{{cookiecutter.project_name}}/.github/next_steps/02_zenodo_integration.md @@ -1,5 +1,22 @@ --- -title: 'Next step: Zenodo integration' +title: 'Next step: Enable Zenodo integration' --- -Zenodo integration instructions. +By enabling Zenodo integration, your package will automatically get a DOI which can be used to cite your package. After enabling Zenodo integration for your GitHub repository, Zenodo will create a snapshot and archive each release you make on GitHub. Moreover, Zenodo will create a new DOI for each GitHub release of your code. + +To enable Zenodo integration: + +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 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> +1. At this point you should have a DOI. To find out the DOI generated by Zenodo: + 1. Visit https://zenodo.org/deposit and click on your repository link + 1. You will find the DOI on the right column (gray-blue badge) + 1. Click on the badge and copy the **Markdown** badge link +1. Update the badge in your repository + 1. Edit README.md and replace the badge placeholder with the badge link you copied in previous setep. + The badge placeholder is hown below. + + `[![DOI](https://zenodo.org/badge/DOI/.svg)](https://doi.org/)` + +For FAQ about Zenodo please visit . diff --git a/{{cookiecutter.project_name}}/README.dev.md b/{{cookiecutter.project_name}}/README.dev.md index c6a8013b..37614c86 100644 --- a/{{cookiecutter.project_name}}/README.dev.md +++ b/{{cookiecutter.project_name}}/README.dev.md @@ -116,7 +116,7 @@ python3 -m pip install --upgrade pip setuptools python3 -m pip install --no-cache-dir . python3 -m pip install --no-cache-dir .[publishing] -# clean up any previously generated artefacts +# clean up any previously generated artefacts rm -rf {{ cookiecutter.package_name }}.egg-info rm -rf dist @@ -161,5 +161,4 @@ twine upload dist/* ### (3/3) GitHub -Don't forget to also make a release on GitHub. If your repository uses the GitHub-Zenodo integration this will also -trigger Zenodo into making a snapshot of your repository and sticking a DOI on it. +Don't forget to also make a release on GitHub. If your repository uses the GitHub-Zenodo integration this will also trigger Zenodo into making a snapshot of your repository and sticking a DOI on it. From cab5c5d2d7a9add641b69b4ca39ca50c29ff31dd Mon Sep 17 00:00:00 2001 From: Faruk D Date: Mon, 3 May 2021 13:23:56 +0200 Subject: [PATCH 2/9] Update {{cookiecutter.project_name}}/.github/next_steps/02_zenodo_integration.md Co-authored-by: Stefan Verhoeven --- .../.github/next_steps/02_zenodo_integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.project_name}}/.github/next_steps/02_zenodo_integration.md b/{{cookiecutter.project_name}}/.github/next_steps/02_zenodo_integration.md index 76857dc2..f5ef6a18 100644 --- a/{{cookiecutter.project_name}}/.github/next_steps/02_zenodo_integration.md +++ b/{{cookiecutter.project_name}}/.github/next_steps/02_zenodo_integration.md @@ -7,7 +7,7 @@ By enabling Zenodo integration, your package will automatically get a DOI which To enable Zenodo integration: 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 and enable Zenodo integration of your repository by clinking on `On` toggle button. +1. Go to and enable Zenodo integration of your repository by clicking 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> 1. At this point you should have a DOI. To find out the DOI generated by Zenodo: 1. Visit https://zenodo.org/deposit and click on your repository link From e8b469c4008fd9e86f0f2ffde4304c4d94bbb7d5 Mon Sep 17 00:00:00 2001 From: Faruk D Date: Mon, 3 May 2021 13:28:20 +0200 Subject: [PATCH 3/9] change the order of zenodo and citation data issues --- .../.github/workflows/next_steps.yml | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/{{cookiecutter.project_name}}/.github/workflows/next_steps.yml b/{{cookiecutter.project_name}}/.github/workflows/next_steps.yml index 533eec33..fbf0877b 100644 --- a/{{cookiecutter.project_name}}/.github/workflows/next_steps.yml +++ b/{{cookiecutter.project_name}}/.github/workflows/next_steps.yml @@ -12,13 +12,14 @@ jobs: with: filename: .github/next_steps/01_sonarcloud_integration.md id: sonarcloud - - name: Create Zenodo integration issue + + - name: Create citation data issue uses: JasonEtco/create-an-issue@v2 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: - filename: .github/next_steps/02_zenodo_integration.md - id: zenodo + filename: .github/next_steps/02_citation.md + id: citation - name: Create readthedocs issue uses: JasonEtco/create-an-issue@v2 env: @@ -26,13 +27,13 @@ jobs: with: filename: .github/next_steps/03_readthedocs.md id: readthedocs - - name: Create citation data issue + - name: Create Zenodo integration issue uses: JasonEtco/create-an-issue@v2 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: - filename: .github/next_steps/04_citation.md - id: citation + filename: .github/next_steps/04_zenodo_integration.md + id: zenodo - name: Create linting issue uses: JasonEtco/create-an-issue@v2 env: From 317aafed003a61817f867f812540adc61a371298 Mon Sep 17 00:00:00 2001 From: Faruk D Date: Mon, 3 May 2021 13:29:23 +0200 Subject: [PATCH 4/9] rename issue template files --- .../.github/next_steps/{04_citation.md => 02_citation.md} | 0 .../{02_zenodo_integration.md => 04_zenodo_integration.md} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename {{cookiecutter.project_name}}/.github/next_steps/{04_citation.md => 02_citation.md} (100%) rename {{cookiecutter.project_name}}/.github/next_steps/{02_zenodo_integration.md => 04_zenodo_integration.md} (100%) diff --git a/{{cookiecutter.project_name}}/.github/next_steps/04_citation.md b/{{cookiecutter.project_name}}/.github/next_steps/02_citation.md similarity index 100% rename from {{cookiecutter.project_name}}/.github/next_steps/04_citation.md rename to {{cookiecutter.project_name}}/.github/next_steps/02_citation.md diff --git a/{{cookiecutter.project_name}}/.github/next_steps/02_zenodo_integration.md b/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md similarity index 100% rename from {{cookiecutter.project_name}}/.github/next_steps/02_zenodo_integration.md rename to {{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md From a3eed2cc5a8f25f4958dfdef53154d9571088f6d Mon Sep 17 00:00:00 2001 From: Faruk D Date: Mon, 3 May 2021 13:34:19 +0200 Subject: [PATCH 5/9] point to dev docs for release instructions --- .../.github/next_steps/04_zenodo_integration.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md b/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md index f5ef6a18..e320cbec 100644 --- a/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md +++ b/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md @@ -8,12 +8,12 @@ To enable Zenodo integration: 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 and enable Zenodo integration of your repository by clicking 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> -1. At this point you should have a DOI. To find out the DOI generated by Zenodo: +2. Your package will get a DOI only after you make a release. Create a new release as described in +3. At this point you should have a DOI. To find out the DOI generated by Zenodo: 1. Visit https://zenodo.org/deposit and click on your repository link - 1. You will find the DOI on the right column (gray-blue badge) - 1. Click on the badge and copy the **Markdown** badge link -1. Update the badge in your repository + 2. You will find the DOI on the right column (gray-blue badge) + 3. Click on the badge and copy the **Markdown** badge link +4. Update the badge in your repository 1. Edit README.md and replace the badge placeholder with the badge link you copied in previous setep. The badge placeholder is hown below. From 793b9578e472a752c869e160ac00e30e958f5b55 Mon Sep 17 00:00:00 2001 From: Faruk D Date: Mon, 3 May 2021 14:34:06 +0200 Subject: [PATCH 6/9] Update {{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md Co-authored-by: Stefan Verhoeven --- .../.github/next_steps/04_zenodo_integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md b/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md index e320cbec..5fb86ec2 100644 --- a/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md +++ b/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md @@ -14,7 +14,7 @@ To enable Zenodo integration: 2. You will find the DOI on the right column (gray-blue badge) 3. Click on the badge and copy the **Markdown** badge link 4. Update the badge in your repository - 1. Edit README.md and replace the badge placeholder with the badge link you copied in previous setep. + 1. Edit README.md and replace the badge placeholder with the badge link you copied in previous step. The badge placeholder is hown below. `[![DOI](https://zenodo.org/badge/DOI/.svg)](https://doi.org/)` From 1d33da68992c16f2859afa4760b61366ed452d7c Mon Sep 17 00:00:00 2001 From: Faruk D Date: Mon, 3 May 2021 14:34:12 +0200 Subject: [PATCH 7/9] Update {{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md Co-authored-by: Stefan Verhoeven --- .../.github/next_steps/04_zenodo_integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md b/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md index 5fb86ec2..9565db64 100644 --- a/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md +++ b/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md @@ -15,7 +15,7 @@ To enable Zenodo integration: 3. Click on the badge and copy the **Markdown** badge link 4. Update the badge in your repository 1. Edit README.md and replace the badge placeholder with the badge link you copied in previous step. - The badge placeholder is hown below. + The badge placeholder is shown below. `[![DOI](https://zenodo.org/badge/DOI/.svg)](https://doi.org/)` From 29f6d6b3c0d3369e318be388015670802157ce82 Mon Sep 17 00:00:00 2001 From: Faruk D Date: Mon, 3 May 2021 14:34:20 +0200 Subject: [PATCH 8/9] Update {{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md Co-authored-by: Stefan Verhoeven --- .../.github/next_steps/04_zenodo_integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md b/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md index 9565db64..ccfbc58e 100644 --- a/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md +++ b/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md @@ -8,7 +8,7 @@ To enable Zenodo integration: 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 and enable Zenodo integration of your repository by clicking on `On` toggle button. -2. Your package will get a DOI only after you make a release. Create a new release as described in +2. Your package will get a DOI only after you make a release. Create a new release as described in [README.dev.md]({{cookiecutter.repository}}/blob/main/README.dev.md#33-github) 3. At this point you should have a DOI. To find out the DOI generated by Zenodo: 1. Visit https://zenodo.org/deposit and click on your repository link 2. You will find the DOI on the right column (gray-blue badge) From 3d7e7c08fe2a34e0b183d76e5b5533cf7721869a Mon Sep 17 00:00:00 2001 From: Faruk D Date: Mon, 3 May 2021 14:34:40 +0200 Subject: [PATCH 9/9] Update {{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md Co-authored-by: Stefan Verhoeven --- .../.github/next_steps/04_zenodo_integration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md b/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md index ccfbc58e..a0c81a8b 100644 --- a/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md +++ b/{{cookiecutter.project_name}}/.github/next_steps/04_zenodo_integration.md @@ -11,8 +11,8 @@ To enable Zenodo integration: 2. Your package will get a DOI only after you make a release. Create a new release as described in [README.dev.md]({{cookiecutter.repository}}/blob/main/README.dev.md#33-github) 3. At this point you should have a DOI. To find out the DOI generated by Zenodo: 1. Visit https://zenodo.org/deposit and click on your repository link - 2. You will find the DOI on the right column (gray-blue badge) - 3. Click on the badge and copy the **Markdown** badge link + 2. You will find the latest DOI in the right column in Versions box in **Cite all versions?** section + 3. Copy the text of the link. For example `10.5281/zenodo.1310751` 4. Update the badge in your repository 1. Edit README.md and replace the badge placeholder with the badge link you copied in previous step. The badge placeholder is shown below.