Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[INFRA] Update release protocol: PDF upload to Zenodo #1652

Merged
merged 4 commits into from
Nov 21, 2023
Merged

[INFRA] Update release protocol: PDF upload to Zenodo #1652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1c168a1
update pdf uploading step
sappelhoff Nov 13, 2023
9751aab
fix typo
sappelhoff Nov 13, 2023
6581388
be more specific in identifier description (CITATION.cff)
sappelhoff Nov 14, 2023
d5568c9
Merge branch 'master' into relzenodo
Remi-Gau Nov 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,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
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After the 1.9 release here and publishing the 1.9.0 GitHub release on https://github.com/bids-standard/bids-specification-pdf-releases, the Zenodo record for that repo will become active.

I will then update CITATION.cff to include a second identifier like this first one, but detailing the PDFs for versions 1.9.0 and higher

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sappelhoff
Can you locate the release for https://github.com/bids-standard/bids-specification-pdf-releases on zenodo: I made a release but I cannot find it

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mmmh seems like something went wrong, let me check -- I'll let you know!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well I cannot see the bids matlab release either so maybe I am just too old to understand how to click buttons in a GUI.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this may be on Zenodo 🤔 anyways, I deleted your tag and release and re-did them after resetting all webhooks on zenodo and github --> now it has worked.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

by the way: minor detail but our release are vX.Y.Z, no? At least from looking at the github tags on the bids spec repo.

I think the bids spec pdf release does not have the leading "v".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you are right. Why do we prepend a v? that's not really in https://semver.org/, is it?

I think I would prefer dropping the v prefix from now on everywhere

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have seen this v prefix in a few places that use "semver" but that's not systematic.
Fine with me dropping the v from now on. Most people will get it.

type: doi
value: 10.5281/zenodo.3686061

Expand Down
21 changes: 6 additions & 15 deletions Release_Protocol.md
View file
Open in desktop
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 described here: https://github.com/bids-standard/bids-specification-pdf-releases#release-instructions

### 11. Sharing news of the release

Expand Down