testaction

https://github.com/dieghernan/testaction

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 5 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.2%) to scientific vocabulary

Keywords from Contributors

cff citation-file-format citation-files hack

Last synced: 6 months ago · JSON representation ·

Repository

Basic Info

Host: GitHub
Owner: dieghernan
License: mit
Default Branch: main
Size: 2.44 MB

Statistics

Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Created over 3 years ago · Last pushed about 1 year ago

Metadata Files

Readme Funding Citation

cff-validator

latest-version

A GitHub action to validate CITATION.cff files with R.

Introduction

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:

``` yaml on: push: paths: - CITATION.cff workflow_dispatch:

name: CITATION.cff jobs: Validate-CITATION-cff: runs-on: ubuntu-latest name: Validate CITATION.cff env: GITHUBPAT: ${{ secrets.GITHUBTOKEN }} 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@main

  # Upload artifact
  - uses: actions/upload-artifact@v2
    if: failure()
    with:
      name: citation-cff-errors
      path: citation_cff_errors.md

```

On error, the action shows the results of the validation highlighting the fields with errors.

It also generates an artifact named citation-cff-errors that includes a markdown file with a high-level summary of the errors found:

citation_cff_errors.md

Table: **./examples/key-error/CITATION.cff errors:** |field |message | |:---------------|:--------------------------------| |data |has additional properties | |data.authors.0 |no schemas match | |data.doi |referenced schema does not match | |data.keywords.0 |is the wrong type | |data.license |referenced schema does not match | |data.url |referenced schema does not match | See [Guide to Citation File Format schema version 1.2.0](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md) for debugging.

For more examples, see the actions provided on this path.

Add a badge to your repo

You can easily create a badge showing the current status of validation of your CITATION.cff like this:

See a quick demo:

Inputs available

citation-path: Path to .cff file to be validated. By default it selects a CITATION.cff file on the root of the repository:

yaml - name: Validate CITATION.cff uses: dieghernan/cff-validator@main with: citation-path: "examples/CITATION.cff"

Building on Linux

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:

``` yaml # 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-dev

```

See a full featured implementation on this example.

Under the hood (for useRs)

This action runs a R script that can be easily replicated. See a full reprex:

R script

``` r # install_cran(c("yaml","jsonlite", "jsonvalidate", "knitr") citation_path <- "./key-error/CITATION.cff" citfile <- yaml::read_yaml(citation_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) 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(knitr::kable(attributes(result)$errors, align = "l", caption = paste(citation_path, "errors:") )) message("\n\n------") stop(citation_path, "file not valid. See Artifact: citation-cff-errors for details.") } else { message(citation_path, "is valid.") message("\n\n------") } #> #> #> Table: ./key-error/CITATION.cff errors: #> #> |field |message | #> |:---------------|:--------------------------------| #> |data |has additional properties | #> |data.authors.0 |no schemas match | #> |data.doi |referenced schema does not match | #> |data.keywords.0 |is the wrong type | #> |data.license |referenced schema does not match | #> |data.url |referenced schema does not match | #> #> #> ------ #> Error in eval(expr, envir, enclos): ./key-error/CITATION.cfffile not valid. See Artifact: citation-cff-errors for details. ``` ^{Created on 2021-09-06 by the [reprex package](https://reprex.tidyverse.org) (v2.0.1)}

References

Druskat, S., Spaaks, J. H., Chue Hong, N., Haines, R., Baker, J., Bliven, S., Willighagen, E., Pérez-Suárez, D., & Konovalov, A. (2021). Citation File Format (Version 1.2.0) [Computer software]. https://doi.org/10.5281/zenodo.5171937

Owner

Name: Diego H.
Login: dieghernan
Kind: user
Location: Madrid, ES

Website: https://dieghernan.github.io/
Twitter: dhernangomez
Repositories: 102
Profile: https://github.com/dieghernan

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software in your research, please cite it using these metadata."
title: Ziggy
version: v0.2.1
date-released: "2022-12-08"
abstract: "Ziggy, a portable, scalable infrastructure for science data processing pipelines, is the child of the Transiting Exoplanet Survey Satellite (TESS) pipeline and the grandchild of the Kepler Pipeline."
authors:
- family-names: Tenenbaum
  given-names: Peter
  affiliation: "SETI Institute/NASA Ames Research Center"
  email: Peter.Tenenbaum@nasa.gov
  orcid: "https://orcid.org/0000-0002-1949-4720"
- family-names: Wohler
  given-names: Bill
  affiliation: "SETI Institute/NASA Ames Research Center"
  email: Bill.Wohler@nasa.gov
  orcid: "https://orcid.org/0000-0002-5402-9613"
license-url: "https://github.com/nasa/ziggy/blob/main/LICENSE.pdf"
url: "https://github.com/nasa/ziggy"
repository-code: "https://github.com/nasa/ziggy"
keywords:
  - algorithm
  - analysis
  - arc
  - data
  - data-analysis
  - data-reduction
  - java
  - k2
  - kepler
  - linux
  - macos
  - nasa
  - open-source
  - pipeline
  - science
  - tess
  - ziggy

GitHub Events

Total

Push event: 2

Last Year

Push event: 2

Committers

Last synced: over 1 year ago

All Time

Total Commits: 87
Total Committers: 4
Avg Commits per committer: 21.75
Development Distribution Score (DDS): 0.034

Past Year

Commits: 0
Committers: 0
Avg Commits per committer: 0.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
dieghernan	d**o@g**m	84
Michael Behrisch	o**s@b**e	1
Stephan Druskat	m**l@s**t	1
ImgBotApp	I**p@g**m	1

Committer Domains (Top 20 + Academic)

sdruskat.net: 1 behrisch.de: 1

Issues and Pull Requests

Last synced: 12 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Dependencies

.github/workflows/cff-validator-complete-matrix.yml actions

actions/checkout v2 composite
dieghernan/cff-validator main composite

action.yml actions

actions/cache v3 composite
r-lib/actions/setup-r v2 composite

testaction

Science Score: 67.0%

Keywords from Contributors

Repository

Basic Info

Statistics

Metadata Files

README.md

cff-validator

Introduction

Add a badge to your repo

Inputs available

Building on Linux

Under the hood (for useRs)

References

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Dependencies