-
-
Notifications
You must be signed in to change notification settings - Fork 600
Add citation.cff and note for citing in README #4472
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
base: develop
Are you sure you want to change the base?
Conversation
Signed-off-by: Chin Yeung Li <tli@nexb.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @chinyeungli, see my comments for your consideration.
- name: 'nexB Inc. and others.' | ||
license: Apache-2.0 | ||
url: 'https://github.com/aboutcode-org/scancode-toolkit' | ||
# version: <ToDo> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will the DOI and version/data be automatically added here: #57 (comment)? Which main page are you talking about?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not at the moment. , but I should be able to automate it once the Zenodo concept DOI is available. Since it gets generated after the first (pre-)release after linked to Zenodo, I’ll set up a script to update the CITATION.cff as soon as that DOI is in place.
The approach would be:
- Create a pre-release to trigger zenodo to generate a unique DOI
- get the DOI and update the CITATION.cff (This could be automate after the DOI is generated in (1))
- commit and push the changes (This could be probably automated as well)
- make the pre-release to final
@@ -134,6 +134,9 @@ Other Important Documentation Pages: | |||
|
|||
See also https://aboutcode.org for related companion projects and tools. | |||
|
|||
To cite this repository, visit the main page and click on the 'Cite this | |||
repository' button for APA or BibTeX citation formats. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see this button added, will it be there automatically after a release?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When you add a CITATION.cff file to the default branch of your repository, a link is automatically added to the repository landing page in the right sidebar, with the label "Cite this repository."
Signed-off-by: Chin Yeung Li <tli@nexb.com>
Fixes #57 - Add note about citing in README
Tasks
Run tests locally to check for errors.
The following fields in the
CITATION.cff
file needs to be updated when pushing a new release:The failing tests don't related to this PR.
Signed-off-by: Chin Yeung Li tli@nexb.com