-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Keep CITATION and
citation.cff
in sync with DESCRIPTION (#467)
* 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
1 parent
5b712af
commit 961c8c9
Showing
5 changed files
with
851 additions
and
8 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 |
---|---|---|
|
@@ -24,4 +24,5 @@ | |
^\.devcontainer$ | ||
^CRAN-SUBMISSION$ | ||
^touchstone$ | ||
^\.benchmark$ | ||
^\.benchmark$ | ||
^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,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" | ||
Oops, something went wrong.