Skip to content

Commit

Permalink
Keep CITATION and citation.cff in sync with DESCRIPTION (#467)
Browse files Browse the repository at this point in the history
* Add citation.cff file and associated GHA workflow

* Add NEWS item

* Update contents of CITATION to sync with DESCRIPTION

* Revised NEWS item

* Fix a path

* Pull before push
  • Loading branch information
jamesmbaazam authored Oct 31, 2023
1 parent 5b712af commit 961c8c9
Show file tree
Hide file tree
Showing 5 changed files with 851 additions and 8 deletions.
3 changes: 2 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@
^\.devcontainer$
^CRAN-SUBMISSION$
^touchstone$
^\.benchmark$
^\.benchmark$
^CITATION\.cff$
59 changes: 59 additions & 0 deletions .github/workflows/update-citation-cff.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# 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:
push:
tags-ignore:
- '*'
paths:
- DESCRIPTION
- inst/CITATION
- .github/workflows/update-citation-cff.yaml
workflow_dispatch:

name: Update CITATION.cff

jobs:
update-citation-cff:
runs-on: macos-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 --local user.name "github-actions[bot]"
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add CITATION.cff
git commit -m 'Update CITATION.cff' || echo "No changes to commit"
git pull --rebase origin ${{ github.ref.name }}
git push origin || echo "No changes to commit"
Loading

0 comments on commit 961c8c9

Please sign in to comment.