-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add additional information to project CITATION.cff file #7140
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7140 +/- ##
==========================================
- Coverage 98.13% 98.13% -0.01%
==========================================
Files 1093 1093
Lines 95579 95579
==========================================
- Hits 93797 93796 -1
- Misses 1782 1783 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This GitHub Actions workflow will update the version and date fields in the CITATION.cff file when a new release is done in GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove the on-release workflow. The overhead with maintaining, updating and debugging the workflow is likely going to take more effort than updating the citation manually. The version and date in the citation are not that critical to justify extra work.
To ensure citation file stays up to date, please add a short note to https://github.com/quantumlib/Cirq/blob/main/release.md#bump-the-main-version. I'd be fine leaving it at that, but if you prefer some automation, we can add a simple job to ci-daily.yml, which would cross check citation version / date with those of the last release tag. This can be well left for a separate PR. The latest tag name can be extracted with
git tag --list --sort=-version:refname -- "v[0-9]*" | head -1
Otherwise, the update of the citation itself looks good, thank you for improving that.
OK, will do. I do think it's valuable to automate updates like this, or at least have checks, because values scattered over different files tend to fall out of sync over time. Eventually when we revise the release workflow, it could be made part of that. For now, a ci-daily is a good idea. |
Per discussion in the PR review comments, we don't want to maintain this, and will instead put some checks into the daily CI.
* Add a little bit more info to CITATION.cff * FIx mixed-up URLs in identifiers section * Remove pointless redundant entry for GitHub repo * Add automation to update CITATION.cff upon releases This GitHub Actions workflow will update the version and date fields in the CITATION.cff file when a new release is done in GitHub. * Add info about tools for CITATION.cff files * Remove citation updater GHA workflow Per discussion in the PR review comments, we don't want to maintain this, and will instead put some checks into the daily CI.
Changes:
Add orienting comments to the top of
CITATION.cff
, edit field text a little bit, and add more identifiers and keywordsAdd a GitHub Actions workflow that will update the version number and date in
CITATION.cff
upon new releases in GitHub