Merge branch 'main' into 464-codeconduct

Author: lyashevska

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Added
 
 * Make Code of Conduct optional [#464](https://github.com/NLeSC/python-template/pull/530)
+* Make zenodo next step instructions optional [#520](https://github.com/NLeSC/python-template/pull/520)
 * Make SonarCloud optional [#515](https://github.com/NLeSC/python-template/pull/515)
 * Make citation optional [#471](https://github.com/NLeSC/python-template/pull/471)
 * Make online documentation optional [#476](https://github.com/NLeSC/python-template/pull/476)

copier.yml

@@ -114,6 +114,12 @@ AddCodeConduct:
   default: "{{ template_profile != 'minimum' }}"
   help: Add code of conduct?
 
+AddZenodo:
+  when: "{{ template_profile == 'ask' }}"
+  type: bool
+  default: "{{ template_profile != 'minimum' }}"
+  help: Create a GitHub issue on how to enable Zenodo integration?
+
 AddSonarCloud:
   when: "{{ template_profile == 'ask' }}"
   type: bool

profiles.md

@@ -29,7 +29,7 @@
   - .editorconfig
 
 - publishing and release
-  - zenodo
+  - zenodo #520 
   - keywords
   - changelog.md
   - cffconvert workflow and citation file

template/.github/workflows/next_steps.yml

@@ -8,13 +8,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Create Zenodo integration issue
-        uses: JasonEtco/create-an-issue@v2
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          filename: .github/next_steps/04_zenodo_integration.md
-        id: zenodo
       - name: Create linting issue
         uses: JasonEtco/create-an-issue@v2
         env:
@@ -25,7 +18,6 @@ jobs:
       - name: List created issues
         run: |
           echo 'Created issues that must be completed to have fully working Python package:
-          * Zenodo integration ${{ steps.zenodo.outputs.url }}
           * Linting fixes ${{ steps.linting.outputs.url }}'
       - name: Cleanup files needed to create next steps issues
         run: |

template/.github/workflows/{% if AddCitation %}next_steps_citation_issue.md{% endif %}.jinja

@@ -8,13 +8,15 @@ It is likely that your `CITATION.cff` currently doesn't pass validation. The err
 - [ ] Update the value of the `orcid` key. If you do not have an orcid yet, you can get one here [https://orcid.org/](https://orcid.org/).
 - [ ] Add more authors if needed
 - [ ] Update `date-released` using the YYYY-MM-DD format.
+
+{% if AddZenodo -%}
 - [ ] Update the `doi` key with the conceptDOI for your repository (see [https://help.zenodo.org](https://help.zenodo.org/) for more information on what a conceptDOI is). If your project doesn't have a DOI yet, you can use the string `10.0000/FIXME` to pass validation.
+{%- endif -%}
 - [ ] Verify that the `keywords` array accurately describes your project.
 
 Afterwards, the `cffconvert` GitHub Action should be green.
 
-To make sure services like [Zenodo](https://zenodo.org) and the [Research Software Directory](https://research-software-directory.org/) can keep your citation data up to date, the [`cffconvert`]({{repository_url}}/actions/workflows/cffconvert.yml) GitHub Action checks the following:
-
+To make sure services like {% if AddZenodo -%} [Zenodo](https://zenodo.org) and {%- endif -%} the [Research Software Directory](https://research-software-directory.org/) can keep your citation data up to date, the [`cffconvert`]({{repository_url}}/actions/workflows/cffconvert.yml) GitHub Action checks the following:
 1. Whether your repository includes a `CITATION.cff` file.
 
     _By including this file, authors of the software can receive credit for the work they put in._

template/.github/workflows/{% if AddZenodo %}next_steps_zenodo.yml{% endif %}

@@ -0,0 +1,31 @@
+on: [push]
+permissions:
+  contents: write
+  issues: write
+name: Create an issue for Zenodo
+jobs:
+  next_steps:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Create Zenodo integration issue
+        uses: JasonEtco/create-an-issue@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          filename: .github/workflows/next_steps_zenodo_issue.md
+        id: zenodo
+      - name: List created issues
+        run: |
+          echo 'Created issues that must be completed to have fully working Python package:
+          * Sonarcloud integration ${{ steps.sonarcloud.outputs.url }}'
+      - name: Cleanup files needed to create next steps issues
+        run: |
+          git config --global user.name 'NLeSC Python template'
+          git config --global user.email 'nlesc-python-template@users.noreply.github.com'
+          git pull # other next step workflows may push changes before
+          git rm .github/workflows/next_steps_zenodo.yml
+          git rm .github/workflows/next_steps_zenodo_issue.md
+          git commit -am "Cleanup automated next steps issue generator for zenodo"
+          git push
+

…ext_steps/04_zenodo_integration.md.jinja …t_steps_zenodo_issue.md{% endif %}.jinjatemplate/.github/next_steps/04_zenodo_integration.md.jinja renamed to template/.github/workflows/{% if AddZenodo %}next_steps_zenodo_issue.md{% endif %}.jinja template/.github/next_steps/04_zenodo_integration.md.jinja renamed to template/.github/workflows/{% if AddZenodo %}next_steps_zenodo_issue.md{% endif %}.jinja

@@ -69,4 +69,6 @@ For projects that also build conda packages, e.g. on conda-forge or Bioconda, so
 1. Test {{ package_name }} from bioconda by manually running [Conda verify]({{ repository_url }}/actions/workflows/conda_verify.yml) workflow
 -->
 
+{% if AddZenodo -%}
 Also a Zenodo entry will be made for the release with its own DOI.
+{%- endif %}

template/CONTRIBUTING.md.jinja

@@ -195,4 +195,7 @@ python -m twine upload dist/*
 
 ### (3/3) GitHub
 
-Don't forget to also make a [release on GitHub]({{repository_url}}/releases/new). 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]({{repository_url}}/releases/new).
+{%- if AddZenodo -%}
+GitHub-Zenodo integration will also trigger Zenodo into making a snapshot of your repository and sticking a DOI on it.
+{%- endif -%}

template/README.dev.md.jinja

@@ -7,7 +7,7 @@
 | (1/5) code repository              | [![github repo badge](https://img.shields.io/badge/github-repo-000.svg?logo=github&labelColor=gray&color=blue)]({{repository_url}}) |
 | (2/5) license                      | [![github license badge](https://img.shields.io/github/license/{{github_organization}}/{{package_name}})]({{repository_url}}) |
 | (3/5) community registry           | [![RSD](https://img.shields.io/badge/rsd-{{package_name}}-00a3e3.svg)](https://www.research-software.nl/software/{{package_name}}) [![workflow pypi badge](https://img.shields.io/pypi/v/{{package_name}}.svg?colorB=blue)](https://pypi.python.org/project/{{package_name}}/) |
-| (4/5) citation                     | [![DOI](https://zenodo.org/badge/DOI/<replace-with-created-DOI>.svg)](https://doi.org/<replace-with-created-DOI>) |
+| (4/5) citation                     | {% if AddZenodo -%} [![DOI](https://zenodo.org/badge/DOI/<replace-with-created-DOI>.svg)](https://doi.org/<replace-with-created-DOI>){%- endif -%} |
 | (5/5) checklist                    | [![workflow cii badge](https://bestpractices.coreinfrastructure.org/projects/<replace-with-created-project-identifier>/badge)](https://bestpractices.coreinfrastructure.org/projects/<replace-with-created-project-identifier>) |
 | howfairis                          | [![fair-software badge](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow)](https://fair-software.eu) |
 | **Other best practices**           | &nbsp; |