cff-validator
ActionsTags
(2)
A GitHub action to validate CITATION.cff files with R.
If you have a Citation File Format (cff) on your repository this action would check its validity against the defined schema.
A full valid workflow:
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]
name: CITATION-cff
jobs:
Validate-CITATION-cff:
runs-on: ubuntu-latest
name: Validate CITATION.cff
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
RSPM: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"
steps:
- name: Checkout
uses: actions/checkout@v2
# This is needed for workflows running on
# ubuntu-20.04 or later
- name: Install V8
if: runner.os == 'Linux'
run: |
sudo apt-get install -y libv8-dev
- name: Validate CITATION.cff
uses: dieghernan/cff-validator@mainOn error, the action shows the results of the validation highlighting the fields with errors.
For more examples, see the actions provided on this path.
citation-path: Path to .cff file to be validated. By default it selects a CITATION.cff file on the root of the repository:
- name: Validate CITATION.cff
uses: dieghernan/cff-validator@main
with:
citation-path: "examples/CITATION.cff"This action relies on the R package V8, that has some extra requirements when running on Linux systems. You would need to add the following steps to your action in order to make it run:
# This is needed for workflows running on
# ubuntu-20.04 or later
- name: Install V8
run: |
sudo apt-get install -y libv8-dev
# This is needed for workflows running on
# previous versions of ubuntu
- name: Install V8 on old ubuntu
run: |
# Ubuntu Xenial (16.04) and Bionic (18.04) only
sudo add-apt-repository ppa:cran/v8
sudo apt-get update
sudo apt-get install libnode-devSee a full featured implementation on this example.
This action runs a R script that can be easily replicated. See a full reprex:
R script
# Libraries
install.packages(c("yaml","jsonlite", "jsonvalidate"))
cit_path <- "CITATION.cff"
citfile <- yaml::read_yaml(cit_path)
# All elements to character
citfile <- rapply(citfile, function(x) as.character(x), how = "replace")
# Convert to json
cit_temp <- tempfile(fileext = ".json")
jsonlite::write_json(citfile, cit_temp, pretty = TRUE)
# Manage brackets
citfile_clean <- readLines(cit_temp)
# Search brackets to keep
# Keep ending and starting
keep_lines <- grep('", "', citfile_clean)
keep_lines <- c(keep_lines, grep("\\[$", citfile_clean))
keep_lines <- c(keep_lines, grep(" \\],", citfile_clean))
keep_lines <- c(keep_lines, grep(" \\]$", citfile_clean))
keep_lines <- sort(unique(keep_lines))
if (all(keep_lines > 0)) {
keep_string <- citfile_clean[keep_lines]
citfile_clean[keep_lines] <- ""
}
# Remove rest of brackets
citfile_clean <- gsub('["', '"', citfile_clean, fixed = TRUE)
citfile_clean <- gsub('"]', '"', citfile_clean, fixed = TRUE)
citfile_clean[grep("\\[", citfile_clean)]
if (all(keep_lines > 0)) {
# Add "good" brackets back
citfile_clean[keep_lines] <- keep_string
}
writeLines(citfile_clean, cit_temp)
# Download latest scheme
schema_temp <- tempfile("schema", fileext = ".json")
download.file("https://raw.githubusercontent.com/citation-file-format/citation-file-format/main/schema.json",
schema_temp,
mode = "wb", quiet = TRUE
)
# Validate
result <- jsonvalidate::json_validate(cit_temp,
schema_temp,
verbose = TRUE
)
# Results
message("------\n")
if (result == FALSE) {
print(attributes(result)$errors)
message("\n")
stop(cit_path, " file no valid")
} else {
message(cit_path, " is valid")
}
cff-validator is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Tags
(2)cff-validator is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.