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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# This CITATION.cff file was generated with cffinit.
# 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 👍

message: >-
If pixi contributes to a project that leads to a
scientific publication, please acknowledge this fact by
citing according to this file.
type: software
# Based on recommendation we use the authors that are responsible for the tool from `prefix.dev` as authors.
# Using personal email to possibly outlive the employment at `prefix.dev`.
authors:
- given-names: Ruben
family-names: Arts
email: ruben.arts@hotmail.com
- given-names: Bas
family-names: Zalmstra
email: zalmstra.bas@gmail.com
- given-names: Wolf
family-names: Volprecht
email: w.vollprecht@gmail.com
- given-names: Tim
name-particle: de
family-names: Jager
email: tdejager89@gmail.com
repository-code: 'https://github.com/prefix-dev/pixi/releases/tag/v0.16.1'
url: 'https://pixi.sh/v0.16.1'
abstract: >-
A cross-platform, language agnostic, package/project
management tool for development in virtual environments.
keywords:
- package-management
- project-management
- virtual-environments
- conda
- pypi
- development-tools
- pixi
license: BSD-3-Clause
Loading
Loading