Skip to content

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

Merged
merged 8 commits into from
Mar 21, 2025

Conversation

mhucka
Copy link
Contributor

@mhucka mhucka commented Mar 15, 2025

Changes:

  • Add orienting comments to the top of CITATION.cff, edit field text a little bit, and add more identifiers and keywords

  • Add a GitHub Actions workflow that will update the version number and date in CITATION.cff upon new releases in GitHub

Copy link

codecov bot commented Mar 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.13%. Comparing base (a9c9009) to head (95ebdce).
Report is 5 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mhucka mhucka marked this pull request as ready for review March 17, 2025 21:02
@mhucka mhucka requested review from vtomole and a team as code owners March 17, 2025 21:02
@mhucka mhucka requested review from MichaelBroughton and pavoljuhas and removed request for MichaelBroughton March 17, 2025 21:02
@mhucka mhucka changed the title Add a little bit more info to CITATION.cff Add info to CITATION.cff & add workflow to keep version updated Mar 17, 2025
Copy link
Collaborator

@pavoljuhas pavoljuhas left a 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.

@mhucka
Copy link
Contributor Author

mhucka commented Mar 19, 2025

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.

mhucka and others added 2 commits March 19, 2025 09:15
Per discussion in the PR review comments, we don't want to maintain
this, and will instead put some checks into the daily CI.
@mhucka mhucka changed the title Add info to CITATION.cff & add workflow to keep version updated Add info to CITATION.cff Mar 19, 2025
@mhucka mhucka enabled auto-merge March 19, 2025 16:16
@mhucka mhucka self-assigned this Mar 19, 2025
@mhucka mhucka added this pull request to the merge queue Mar 21, 2025
Merged via the queue into main with commit 2bfa1cd Mar 21, 2025
43 checks passed
@mhucka mhucka changed the title Add info to CITATION.cff Add additional information to project CITATION.cff file Apr 8, 2025
BichengYing pushed a commit to BichengYing/Cirq that referenced this pull request Jun 20, 2025
* 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.
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