Skip to content

Commit 4c25c48

Browse files
committed
remove .zenodo.json and all references to it
CITATION.cff replaces it fully, also for integration with Zenodo. See citation-file-format/citation-file-format#374 or https://twitter.com/zenodo_org/status/1420357001490706442 for more information on this. Concretely, this commit: - Removes .zenodo.json from the template repo - Removes all references to it in README files (also in the package) - Updates the cffconvert GitHub Actions workflow to only validate, whereas previously it also checked the .zenodo.json file for consistency - Simplifies the 02_citation.md "next steps" issue template, because consistency with .zenodo.json no longer has to be checked.
1 parent bba2cc0 commit 4c25c48

6 files changed

Lines changed: 9 additions & 98 deletions

File tree

.zenodo.json

Lines changed: 0 additions & 77 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
* `.pylintrc` file, was too strict, too soon [#267](https://github.com/NLeSC/python-template/issues/267)
3434
* Unused development dependencies [#167](https://github.com/NLeSC/python-template/issues/167)
3535
* Statements in project_setup.md already mentioned in README.dev.md
36+
* .zenodo.json is no longer necessary, CITATION.cff also works with Zenodo.
3637

3738
## 0.4.0
3839

README.dev.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Follow the instructions from `my-python-project/README.dev.md` and make sure tha
9292
### Preparation
9393

9494
1. Make sure the `CHANGELOG.md` has been updated
95-
2. Verify that the information in `CITATION.cff` is correct, and that `.zenodo.json` contains equivalent data
95+
2. Verify that the information in `CITATION.cff` is correct.
9696
3. Make sure that `version` in [setup.cfg](setup.cfg) and `version` in [CITATION.cff](CITATION.cff) have been bumped to the to-be-released version of the template
9797
4. Run the unit tests with `pytest tests/`
9898
5. Go through the steps outlined above for [generating a new package from the command line](#using-cookiecutter-to-generate-a-new-package-from-the-command-line), and verify that the generated package works as it should.

{{cookiecutter.directory_name}}/.github/next_steps/02_citation.md

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ It is likely that your `CITATION.cff` currently doesn't pass validation. The err
1111
- [ ] 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.
1212
- [ ] Verify that the `keywords` array accurately describes your project.
1313

14-
Once you do all the steps above, the `cffconvert` workflow will tell you what content it expected to see in `.zenodo.json`. Copy-paste from the GitHub Action log into a new file `.zenodo.json`. Afterwards, the `cffconvert` GitHub Action should be green.
14+
Afterwards, the `cffconvert` GitHub Action should be green.
1515

16-
17-
To help you keep the citation metadata up to date and synchronized, the [`cffconvert`]({{cookiecutter.repository_url}}/actions/workflows/cffconvert.yml) GitHub Action checks the following 6 aspects:
16+
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`]({{cookiecutter.repository_url}}/actions/workflows/cffconvert.yml) GitHub Action checks the following:
1817

1918
1. Whether your repository includes a `CITATION.cff` file.
2019

@@ -27,17 +26,3 @@ To help you keep the citation metadata up to date and synchronized, the [`cffcon
2726
1. Whether your `CITATION.cff` adheres to the schema (as listed in the `CITATION.cff` file itself under key `cff-version`).
2827

2928
_The Citation File Format schema can be found [here](https://github.com/citation-file-format/citation-file-format), along with an explanation of all the keys. You're advised to use the latest available schema version._
30-
31-
1. Whether your repository includes a `.zenodo.json` file.
32-
33-
_With this file, you can control what metadata should be associated with any future releases of your software on Zenodo: things like the author names, along with their affiliations and their ORCIDs, the license under which the software has been released, as well as the name of your software and a short description. If your repository doesn't have a .zenodo.json file, Zenodo will take a somewhat crude guess to assign these metadata._
34-
35-
_The `cffconvert` GitHub action will tell you what it expects to find in `.zenodo.json`, just copy and paste it to a new file named `.zenodo.json`. The suggested text ignores CITATION.cff's `version`, `commit`, and `date-released`. `cffconvert` considers these keys `suspect` in the sense that they are often out of date, and there is little purpose to telling Zenodo about these properties: Zenodo already knows._
36-
37-
1. Whether `.zenodo.json` is valid JSON.
38-
39-
_Currently unimplemented, but you can check for yourself on [https://jsonlint.com/](https://jsonlint.com/)._
40-
41-
1. Whether `CITATION.cff` and `.zenodo.json` contain equivalent data.
42-
43-
_This final check verifies that the two files are in sync. The check ignores CITATION.cff's `version`, `commit`, and `date-released`._

{{cookiecutter.directory_name}}/.github/workflows/cffconvert.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,7 @@ jobs:
1717
- uses: actions/checkout@v3
1818
name: Check out a copy of the repository
1919

20-
- uses: citation-file-format/cffconvert-github-action@main
21-
name: Check whether the citation metadata from CITATION.cff is equivalent to that in .zenodo.json
20+
- name: Check whether the citation metadata from CITATION.cff is valid
21+
uses: citation-file-format/cffconvert-github-action@2.0.0
22+
with:
23+
args: "--validate"

{{cookiecutter.directory_name}}/README.dev.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ This section describes how to make a release in 3 parts:
132132
### (1/3) Preparation
133133

134134
1. Update the <CHANGELOG.md> (don't forget to update links at bottom of page)
135-
2. Verify that the information in `CITATION.cff` is correct, and that `.zenodo.json` contains equivalent data
135+
2. Verify that the information in [`CITATION.cff`](CITATION.cff) is correct.
136136
3. Make sure the [version has been updated](#versioning).
137137
4. Run the unit tests with `pytest -v`
138138

0 commit comments

Comments
 (0)