Skip to content

Commit

Permalink
update pdf uploading step
Browse files Browse the repository at this point in the history
  • Loading branch information
sappelhoff committed Nov 13, 2023
1 parent 51a40fb commit 1c168a1
Showing 1 changed file with 6 additions and 15 deletions.
21 changes: 6 additions & 15 deletions Release_Protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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
Expand Down Expand Up @@ -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

Check failure on line 250 in Release_Protocol.md

View workflow job for this annotation

GitHub Actions / codespell

descibed ==> described

### 11. Sharing news of the release

Expand Down

0 comments on commit 1c168a1

Please sign in to comment.