Objective
Write this new document. Goal is to describe to users how to enable "Cite this repository" in their GitHub repo. Specifically note this can be done BEFORE releasing a new version by knowing ahead of time the release tag (e.g. the version number), or AFTER a release (because GitHub repo web interface will reference the CITATION.cff in default branch).
Reference
These are notes I gave to a person who doubted the file could be set to the correct version before a release.
On GitHub, no need to create new version.
- 2 days ago, I released version 1.0.0 of a software I maintain.
- Today, I added a CITATION.cff (as generated from cff init site).
- Now, I see "Cite this repository ▾" on the software home page.
- And, version is still 1.0.0 (I did not update it).
My example is available at https://github.com/TACC/mkdocs-tacc . I added it before release via @pr 36: docs: cite this software for v1.0.0. And after releasing v1.0.1, I updated the CITATION.cff after the fact in TACC/mkdocs-tacc@98c6d867.
Objective
Write this new document. Goal is to describe to users how to enable "Cite this repository" in their GitHub repo. Specifically note this can be done BEFORE releasing a new version by knowing ahead of time the release tag (e.g. the version number), or AFTER a release (because GitHub repo web interface will reference the CITATION.cff in default branch).
Reference
These are notes I gave to a person who doubted the file could be set to the correct version before a release.
My example is available at https://github.com/TACC/mkdocs-tacc . I added it before release via @pr 36: docs: cite this software for v1.0.0. And after releasing v1.0.1, I updated the CITATION.cff after the fact in TACC/mkdocs-tacc@98c6d867.