From 1c168a1d7b2e635fdafb49a8bc3311611c6a0e8c Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Mon, 13 Nov 2023 20:03:17 +0100 Subject: [PATCH 1/3] update pdf uploading step --- Release_Protocol.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/Release_Protocol.md b/Release_Protocol.md index 5773da78e3..e798eb60ec 100644 --- a/Release_Protocol.md +++ b/Release_Protocol.md @@ -164,7 +164,7 @@ For example: Verify that the pull request title matches "REL: vX.Y.Z" and merge the pull request. -### 6. Get the built PDF +### 6. Get the built PDF and `CITATION.cff` file Upon each commit to the `master` branch, CircleCI builds a PDF version of the specification (see `.circleci/config.yml` and the `pdf_build_src` directory). @@ -178,6 +178,9 @@ jobs to finish and then check the built PDF using the following steps: 1. Download the PDF and check that the date and version on the first page are as expected 1. Hold the PDF ready for upload to our Zenodo archive (see the *Uploading the stable PDF to Zenodo* step below) +Furthermore, **copy the `CITATION.cff`** file in its current state from the root of the repository +and hold it ready for facilitating the upload of the PDF to our Zenodo archive. + ### 7. Tag the release GitHub's release mechanism does not have all of the features we need, so manually tag the release @@ -243,20 +246,8 @@ Similarly update the version in CITATION.cff with a `dev` suffix. ### 10. Uploading the stable PDF to Zenodo -1. Open a private browser window -1. Log into https://github.com with the `bids-maintenance` user (credentials - are available from the BIDS maintainer group) -1. Open a new tab at https://zenodo.org and "log in via GitHub", you'll then - be on the `bids-maintenance` Zenodo account -1. Navigate to the [archive of our BIDS specification PDFs](https://doi.org/10.5281/zenodo.3686061) -1. Click on "add new version" -1. For a new version, upload the new PDF, naming it consistently with the other - PDFs: `BIDS-Specification-vX.X.X.pdf` (replace `X.X.X` with the new version) -1. Remove all other files from the upload -1. Edit the following fields: - 1. publication date - 1. version -1. Double check that everything is in order, then save and publish +1. In a previous step you have secured a PDF version of the BIDS specification and the corresponding `CITATION.cff` file. +1. Follow the steps descibed here: https://github.com/bids-standard/bids-specification-pdf-releases#release-instructions ### 11. Sharing news of the release From 9751aab175453e654ad65313430702b4dbdb6d71 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Mon, 13 Nov 2023 20:05:22 +0100 Subject: [PATCH 2/3] fix typo --- Release_Protocol.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Release_Protocol.md b/Release_Protocol.md index e798eb60ec..30b5d2b429 100644 --- a/Release_Protocol.md +++ b/Release_Protocol.md @@ -247,7 +247,7 @@ Similarly update the version in CITATION.cff with a `dev` suffix. ### 10. Uploading the stable PDF to Zenodo 1. In a previous step you have secured a PDF version of the BIDS specification and the corresponding `CITATION.cff` file. -1. Follow the steps descibed here: https://github.com/bids-standard/bids-specification-pdf-releases#release-instructions +1. Follow the steps described here: https://github.com/bids-standard/bids-specification-pdf-releases#release-instructions ### 11. Sharing news of the release From 658138864876a2e40a7ff23036f4085fd645890c Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Tue, 14 Nov 2023 18:23:15 +0100 Subject: [PATCH 3/3] be more specific in identifier description (CITATION.cff) --- CITATION.cff | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index ef9976621b..7881a5b42f 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -17,7 +17,7 @@ repository-code: https://github.com/bids-standard/bids-specification message: Please cite it as below. identifiers: - - description: bids-specification + - description: PDFs of the BIDS specification for versions 1.0.0 to 1.8.0 type: doi value: 10.5281/zenodo.3686061