Skip to content

Commit

Permalink
Add codemeta.json and cffr citation.
Browse files Browse the repository at this point in the history
  • Loading branch information
aravind-j committed May 22, 2023
1 parent 1f7a94a commit fed0e9c
Show file tree
Hide file tree
Showing 7 changed files with 519 additions and 320 deletions.
58 changes: 58 additions & 0 deletions .github/workflows/update-citation-cff.yaml
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: 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 push origin || echo "No changes to commit"
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.4.1
# CITATION file created with {cffr} R package, v0.5.0
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------

Expand Down
6 changes: 6 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ output: rmarkdown::github_document
always_allow_html: true
---

```{r, results='asis', echo=FALSE}
glue::glue('<script type="application/ld+json">
{glue::glue_collapse(readLines("inst/schemaorg.json"), sep = "\n")}
</script>')
```

```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
Expand Down
351 changes: 198 additions & 153 deletions README.html

Large diffs are not rendered by default.

Loading

0 comments on commit fed0e9c

Please sign in to comment.