Skip to content

Commit 2b5fd19

Browse files
authored
Merge pull request #1652 from sappelhoff/relzenodo
[INFRA] Update release protocol: PDF upload to Zenodo
2 parents b0e6744 + d5568c9 commit 2b5fd19

File tree

2 files changed

+7
-16
lines changed

2 files changed

+7
-16
lines changed

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ repository-code: https://github.com/bids-standard/bids-specification
1616
message: Please cite it as below.
1717

1818
identifiers:
19-
- description: bids-specification
19+
- description: PDFs of the BIDS specification for versions 1.0.0 to 1.8.0
2020
type: doi
2121
value: 10.5281/zenodo.3686061
2222

Release_Protocol.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ For example:
164164

165165
Verify that the pull request title matches "REL: vX.Y.Z" and merge the pull request.
166166

167-
### 6. Get the built PDF
167+
### 6. Get the built PDF and `CITATION.cff` file
168168

169169
Upon each commit to the `master` branch, CircleCI builds a PDF version of the
170170
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:
178178
1. Download the PDF and check that the date and version on the first page are as expected
179179
1. Hold the PDF ready for upload to our Zenodo archive (see the *Uploading the stable PDF to Zenodo* step below)
180180

181+
Furthermore, **copy the `CITATION.cff`** file in its current state from the root of the repository
182+
and hold it ready for facilitating the upload of the PDF to our Zenodo archive.
183+
181184
### 7. Tag the release
182185

183186
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.
243246

244247
### 10. Uploading the stable PDF to Zenodo
245248

246-
1. Open a private browser window
247-
1. Log into https://github.com with the `bids-maintenance` user (credentials
248-
are available from the BIDS maintainer group)
249-
1. Open a new tab at https://zenodo.org and "log in via GitHub", you'll then
250-
be on the `bids-maintenance` Zenodo account
251-
1. Navigate to the [archive of our BIDS specification PDFs](https://doi.org/10.5281/zenodo.3686061)
252-
1. Click on "add new version"
253-
1. For a new version, upload the new PDF, naming it consistently with the other
254-
PDFs: `BIDS-Specification-vX.X.X.pdf` (replace `X.X.X` with the new version)
255-
1. Remove all other files from the upload
256-
1. Edit the following fields:
257-
1. publication date
258-
1. version
259-
1. Double check that everything is in order, then save and publish
249+
1. In a previous step you have secured a PDF version of the BIDS specification and the corresponding `CITATION.cff` file.
250+
1. Follow the steps described here: https://github.com/bids-standard/bids-specification-pdf-releases#release-instructions
260251

261252
### 11. Sharing news of the release
262253

0 commit comments

Comments
 (0)