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

feat: add citation file #908

Merged
merged 6 commits into from
Mar 11, 2024
Merged

Conversation

ruben-arts
Copy link
Contributor

Adding citation file as requested.

@matthewfeickert could you check if I did this correctly?

We decided to not name anyone in the citation directly but take everyone in by mentioning the contributors.

Closes #891

Copy link
Contributor

@matthewfeickert matthewfeickert left a comment

Choose a reason for hiding this comment

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

Overall looks good, and while I didn't verify it, I assume that as you generated it with the helper that this is all valid and passes cffconvert --validate. I would make some revisions in terms of adding in version information into the citation and also the author list though.

Here's a CITAITON.cff file for a project that I'm a primary maintainer on as an example. (If you're not preparing the citation metadata to also populate the information in other services, like Zenodo, then things like doi are probably not relevant to you, but most of the rest of the information on there before the references I think is useful to make citation as easy and useful as possible for people.)

# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: pixi
Copy link
Contributor

Choose a reason for hiding this comment

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

I haven't checked the codebase to see how you handle versioning release information, but I would add the version key here too.

Copy link
Contributor

Choose a reason for hiding this comment

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

If you decide to incorporate the version here, please make a CI check that the version is synced with the one in Cargo.toml, otherwise it will drift 100%.

Copy link
Contributor

Choose a reason for hiding this comment

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

More an "and" than an "or" but even if you only use VCS information for version information I would use some sort of version bump tool like tbump to try to go through and update information everywhere it exists.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I would love to automate this but I want to automate the complete release and add this part to it. I've been experimenting with release-plz as rattler uses it but I haven't figure it out nicely yet. So in this PR I added the tbump as a preperation but it is not used in CI yet.

Added the versions to the urls 👍

CITATION.cff Outdated
Comment on lines 11 to 12
authors:
- given-names: pixi open-source contributors
Copy link
Contributor

Choose a reason for hiding this comment

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

While I understand the idea to want to give credit to everyone who contributed, I would recommend adding the names of people who have "responsibility" for pixi within prefix.dev here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Followed your advice!

CITATION.cff Outdated Show resolved Hide resolved
CITATION.cff Outdated Show resolved Hide resolved
@baszalmstra
Copy link
Contributor

@matthewfeickert Thanks for the review!

I was wondering, do you use a tool to update the versions everywhere when you want to do a release, or is it just search and replace?

@prefix-dev prefix-dev deleted a comment from prefix-dev-atlantis bot Mar 8, 2024
@prefix-dev prefix-dev deleted a comment from prefix-dev-atlantis bot Mar 8, 2024
@prefix-dev prefix-dev deleted a comment from wolfv Mar 8, 2024
@matthewfeickert
Copy link
Contributor

I was wondering, do you use a tool to update the versions everywhere when you want to do a release, or is it just search and replace?

Yes. In pyhf we use tbump to bump the versions everywhere in the code base as part of the release process.

@ruben-arts
Copy link
Contributor Author

He @matthewfeickert,

Thanks a lot for your input, I'm a little uncomfortable with the version stuff that's why I procrastinated this PR a little, sorry for that. I'll work on automating the bumping in a different PR as nothing about the release is automated currently but it is high on my radar.

@matthewfeickert
Copy link
Contributor

Sounds great @ruben-arts. Nothing to apologize for on your end though. I think it is very nice that this is being looked at period, so I don't think you should feel any timeline pressure here. 👍

@ruben-arts ruben-arts requested a review from wolfv March 11, 2024 08:13
tbump.toml Outdated Show resolved Hide resolved
@ruben-arts ruben-arts enabled auto-merge (squash) March 11, 2024 15:10
@ruben-arts ruben-arts merged commit 4b57d50 into prefix-dev:main Mar 11, 2024
13 of 14 checks passed
@ruben-arts ruben-arts deleted the misc/add_citation branch March 11, 2024 15:16
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.

Add citation files
5 participants