Skip to content

Add automation to update CITATION.cff upon releases#902

Closed
mhucka wants to merge 2 commits intoquantumlib:mainfrom
mhucka:mh-add-cff-updater-workflow
Closed

Add automation to update CITATION.cff upon releases#902
mhucka wants to merge 2 commits intoquantumlib:mainfrom
mhucka:mh-add-cff-updater-workflow

Conversation

@mhucka
Copy link
Copy Markdown
Contributor

@mhucka mhucka commented Mar 17, 2025

This GitHub Actions workflow will update the version and date fields in the CITATION.cff file when a new release is done in GitHub.

This GitHub Actions workflow will update the version and date fields
in the CITATION.cff file when a new release is done in GitHub.
@mhucka mhucka marked this pull request as ready for review March 17, 2025 21:02
@mhucka mhucka requested a review from Strilanc March 17, 2025 21:02
@Strilanc
Copy link
Copy Markdown
Collaborator

Does this do the wrong thing if I do something like release 1.15.0, then later release 1.14.1 (e.g. due to backporting a fix to a security vulnerability)?

@mhucka
Copy link
Copy Markdown
Contributor Author

mhucka commented Mar 24, 2025

It shouldn't, as this triggers on the release event and gets the version number from that event (via variable github.event.release.tag_name).

However, Matt Harrigan pointed out a chicken-and-egg problem with the workflow: by acting on a release event, it means that that the updated citation.cff will not actually be part of the release. I think the solution will be to trigger on the tagging event, rather than the release event. I still need to test that, though.

I'm going to revert this back to a draft PR for now.

@mhucka mhucka marked this pull request as draft March 24, 2025 23:32
@mhucka mhucka closed this Apr 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants