-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create citation files and processing (#167)
* Create CITATION.cff at root * Create standard R inst/CITATION file * Use github action for citations * Use ubuntu on workflow * Only run workflow on main branch
- Loading branch information
1 parent
33355ef
commit 3228cea
Showing
4 changed files
with
660 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,3 +21,4 @@ $run_dev.* | |
^codecov\.yml$ | ||
^.lintr$ | ||
^cran-comments\.md$ | ||
^CITATION\.cff$ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Workflow derived from https://github.com/r-lib/actions/tree/master/examples | ||
# The action runs when: | ||
# - A new release is published | ||
# - The DESCRIPTION or inst/CITATION are modified | ||
# - Can be run manually | ||
# For customizing the triggers, visit https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows | ||
on: | ||
release: | ||
types: [published] | ||
push: | ||
branches: [master, main] | ||
paths: | ||
- DESCRIPTION | ||
- inst/CITATION | ||
workflow_dispatch: | ||
|
||
name: Update CITATION.cff | ||
|
||
jobs: | ||
update-citation-cff: | ||
runs-on: ubuntu-latest | ||
env: | ||
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: r-lib/actions/setup-r@v2 | ||
- uses: r-lib/actions/setup-r-dependencies@v2 | ||
with: | ||
extra-packages: | | ||
any::cffr | ||
any::V8 | ||
- name: Update CITATION.cff | ||
run: | | ||
library(cffr) | ||
# Customize with your own code | ||
# See https://docs.ropensci.org/cffr/articles/cffr.html | ||
# Write your own keys | ||
mykeys <- list() | ||
# Create your CITATION.cff file | ||
cff_write(keys = mykeys) | ||
shell: Rscript {0} | ||
|
||
- name: Commit results | ||
run: | | ||
git config --global user.name "github-actions" | ||
git config --global user.email "[email protected]" | ||
git add CITATION.cff | ||
git commit -m 'Update CITATION.cff' || echo "No changes to commit" | ||
git push origin || echo "No changes to commit" | ||
Oops, something went wrong.