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.

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

Conversation

sappelhoff
Copy link
Member

@sappelhoff sappelhoff added the exclude-from-changelog This item will not feature in the automatically generated changelog label Nov 13, 2023
@@ -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
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.

@sappelhoff
Copy link
Member Author

sappelhoff commented Nov 21, 2023

@Remi-Gau you could merge this PR via a "Create a merge commit" method to autofix the changelog (ref #1658):

image

I actually noticed some items like #1483 missing from the changelog, because "the most recent PR before the release wasn't merged via a Merge commit"

NOTE: Before you start a release, you have to ensure that the automatically generated changelog is
**up to date**. See the relevant [section in CONTRIBUTING.md](CONTRIBUTING.md#how-is-the-changelog-generated)
for further information. In practice this means ensuring that the most recently merged pull request was
merged into the `master` branch using the "Merge commit" option.

this is obviously just a shortcoming in our release protocol (and the way we trigger the github changelog generator), so please just read this as a note to all of us that we should improve the docs on that (and maybe even the process itself) when we find time.

@Remi-Gau Remi-Gau merged commit 2b5fd19 into bids-standard:master Nov 21, 2023
23 of 24 checks passed
@sappelhoff sappelhoff deleted the relzenodo branch November 21, 2023 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
exclude-from-changelog This item will not feature in the automatically generated changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Publish list of authors with the PDF of the specifications on Zenodo
2 participants