Citation information

[davidwyld]

• Adds citation file format (cff) citation file.
• Adds actions workflow to validate cff (only runs when this file is changed)
• Adds some info to the readme on reporting usage and citation of the software.

To do:

• add citation reminder/link to frontend
• add citation reminder/link to documentation
• version number file
• workflow to check consistency of version numbers in version file and citation file

Unsolved issues:

• Does anyone have any ideas on how to automatically update the version number/commit hash in the citation file (but also goes for the package.json maybe) when we create a release?
  • I could easily create an action to run on a new release to update the file, but then the file would be changed in a subsequent commit, meaning it isn't correct in the tagged version.
  • So it seems like manually doing it before tagging a release seems to be the best way, unfortunately?

[github-actions]

Jest Coverage

File	% Stmts	% Branch	% Funcs	% Lines	Uncovered Line #s
All files	80.11	79.16	78.26	80.11

Details

File	% Stmts	% Branch	% Funcs	% Lines	Uncovered Line #s
All files	80.11	79.16	78.26	80.11
_src/components	74.73	75.51	79.16	74.73
_ AnnotationRenderer.vue	73.62	75.51	76.19	73.62	114,123-124,178,201,221,228-242,250,256-266,283
_ MarkdownEditor.vue	100	100	100	100
_ MarkdownRenderer.vue	100	100	100	100
_src/components/annotation	78.57	86.66	76.47	78.57
_ CheckboxInput.vue	85.71	100	100	85.71	19
_ HtmlDisplay.vue	80	100	100	80	26-30
_ InputErrorDisplay.vue	100	0	100	100	19-25
_ RadioInput.vue	71.42	100	66.66	71.42	19,26
_ SelectorInput.vue	71.42	100	66.66	71.42	20,27
_ TextInput.vue	75	100	66.66	75	26
_ TextareaInput.vue	66.66	100	50	66.66	20
_src/enum	100	100	100	100
_ DocumentTypes.js	100	100	100	100
_src/jrpc	90.32	83.33	75	90.32
_ index.js	90.32	83.33	75	90.32	29,38-39
_src/utils	100	100	100	100
_ annotations.js	100	100	100	100
_tests/unit	100	100	100	100
_ globalVue.js	100	100	100	100

[ianroberts]

Does anyone have any ideas on how to automatically update the version number/commit hash in the citation file (but also goes for the package.json maybe) when we create a release?

• I could easily create an action to run on a new release to update the file, but then the file would be changed in a subsequent commit, meaning it isn't correct in the tagged version.
• So it seems like manually doing it before tagging a release seems to be the best way, unfortunately?

This seems something of a chicken and egg problem - you can't know the correct commit hash until after you've made the commit that you're going to tag as the release, but as soon as you commit the new hash it's already out of date. So that might be an argument for not bothering with the hash and just using the version number, but then the same would seem to be true of some other keys in the file, e.g. we can't know the DOI for a release until after the release has been made and archived by Zenodo. So the CITATION.cff file in a release will always be out of date, but the file on the main branch can be accurate with respect to the most recent release.

[ianroberts]

When we do get to the point of a true release (not zero-point-something) I suggest we make the initial one version 2.0.0 rather than 1.anything, as it's the "spiritual successor" of the original Teamware v1.4