From 39665f9e812d280353f43fe8989dca8cfbe250ba Mon Sep 17 00:00:00 2001 From: FrLars21 <149402342+FrLars21@users.noreply.github.com> Date: Mon, 2 Sep 2024 16:51:34 +0200 Subject: [PATCH] added gh action --- .Rbuildignore | 1 + .github/.gitignore | 1 + .github/workflows/R-CMD-check.yaml | 52 ++++++++++++++++++++++++++++++ R/noegletal_get.R | 2 +- README.Rmd | 1 + README.md | 2 ++ 6 files changed, 58 insertions(+), 1 deletion(-) create mode 100644 .github/.gitignore create mode 100644 .github/workflows/R-CMD-check.yaml diff --git a/.Rbuildignore b/.Rbuildignore index ead3cf8..f93bc58 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -2,3 +2,4 @@ ^\.Rproj\.user$ ^LICENSE\.md$ ^README\.Rmd$ +^\.github$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml new file mode 100644 index 0000000..d46a617 --- /dev/null +++ b/.github/workflows/R-CMD-check.yaml @@ -0,0 +1,52 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + +name: R-CMD-check.yaml + +permissions: read-all + +jobs: + R-CMD-check: + runs-on: ${{ matrix.config.os }} + + name: ${{ matrix.config.os }} (${{ matrix.config.r }}) + + strategy: + fail-fast: false + matrix: + config: + - {os: macos-latest, r: 'release'} + - {os: windows-latest, r: 'release'} + - {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'} + - {os: ubuntu-latest, r: 'release'} + - {os: ubuntu-latest, r: 'oldrel-1'} + + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + R_KEEP_PKG_SOURCE: yes + + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + r-version: ${{ matrix.config.r }} + http-user-agent: ${{ matrix.config.http-user-agent }} + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::rcmdcheck + needs: check + + - uses: r-lib/actions/check-r-package@v2 + with: + upload-snapshots: true + build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")' diff --git a/R/noegletal_get.R b/R/noegletal_get.R index 7a03c6b..4624fa4 100644 --- a/R/noegletal_get.R +++ b/R/noegletal_get.R @@ -145,7 +145,7 @@ noegletal_get <- function(muni_codes = ALLOWED_MUNI_CODES, #' @param muni_codes Vector of municipality codes #' @param years Vector of years #' @param variable_ids Vector of variable IDs -#' @returns void +#' @returns None #' @noRd validate_input <- function(muni_codes, years, variable_ids) { if (!all(muni_codes %in% ALLOWED_MUNI_CODES)) { diff --git a/README.Rmd b/README.Rmd index f745807..2f9ca58 100644 --- a/README.Rmd +++ b/README.Rmd @@ -16,6 +16,7 @@ knitr::opts_chunk$set( # noegletalR +[![R-CMD-check](https://github.com/FrLars21/noegletalR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/FrLars21/noegletalR/actions/workflows/R-CMD-check.yaml) The goal of noegletalR is to provide a friendly interface between R and 'noegletal.dk', diff --git a/README.md b/README.md index 6e1634f..e6ce592 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ # noegletalR + +[![R-CMD-check](https://github.com/FrLars21/noegletalR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/FrLars21/noegletalR/actions/workflows/R-CMD-check.yaml) The goal of noegletalR is to provide a friendly interface between R and