Merge pull request #57 from inbo/live-test

Add R-CMD-CHECK: no tests, no examples + changes to readme

Author: PietrH

.Rbuildignore

@@ -3,3 +3,4 @@
 ^LICENSE\.md$
 ^README\.Rmd$
 [.]js$
+^\.github$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/R-CMD-CHECK-lite.yml

@@ -0,0 +1,57 @@
+# 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
+
+# Since Github Actions doesn't have access to the database, tests and examples are disabled.
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+name: R-CMD-check-lite.yaml NO TESTS NO EXAMPLES
+
+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'}
+          - {os: ubuntu-latest,   r: '3.6.3'}
+
+    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: false
+          build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'
+          args: 'c("--no-manual", "--no-tests", "--no-examples")'
+          error-on: '"warning"'

.github/workflows/R-CMD-check-lite.yaml

@@ -1,6 +1,6 @@
 Package: etnservice
 Title: Serve Data from the European Tracking Network
-Version: 0.1.0
+Version: 0.1.1
 Authors@R: c(
     person("Pieter", "Huybrechts", , "pieter.huybrechts@inbo.be", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0002-6658-6062")),

DESCRIPTION

@@ -1,5 +1,7 @@
-# etnservice v0.1.0
+# etnservice 0.1.1
+- Added badges to the readme
+- Improvements to CI, note that tests and examples are not checked on github. These still need to be checked on a machine that has access to the ETN database.
 
+# etnservice v0.1.0
 - This is the first version of etnservice used in the beta of etn v2.3.0.
 - This version is still lagging behind it's contemporary version of etn v2.2.1, which means that database queries made via etnservice, or via the OpenCPU API are not guaranteed to be identical as the results of the same queries made via the etn R package.
-

NEWS.md

@@ -17,6 +17,8 @@ knitr::opts_chunk$set(
 
 <!-- badges: start -->
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
+[![R-CMD-check](https://github.com/inbo/etnservice/actions/workflows/R-CMD-check-lite.yaml/badge.svg)](https://github.com/inbo/etnservice/actions/workflows/R-CMD-check-lite.yaml)
 <!-- badges: end -->
 
 The goal of etnservice is to to serve data from the European Tracking Network as a restful API.

README.Rmd

@@ -7,6 +7,10 @@
 
 [![Lifecycle:
 experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[![Project Status: WIP – Initial development is in progress, but there
+has not yet been a stable, usable release suitable for the
+public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
+[![R-CMD-check](https://github.com/inbo/etnservice/actions/workflows/R-CMD-check-lite.yaml/badge.svg)](https://github.com/inbo/etnservice/actions/workflows/R-CMD-check-lite.yaml)
 <!-- badges: end -->
 
 The goal of etnservice is to to serve data from the European Tracking
@@ -21,10 +25,10 @@ LifeWatch. ETN data is subject to the [ETN data
 policy](http://www.lifewatch.be/etn/assets/docs/ETN-DataPolicy.pdf) and
 can be:
 
-  - restricted: under moratorium and only accessible to logged-in data
-    owners/collaborators
-  - unrestricted: publicly accessible without login and routinely
-    published to international biodiversity facilities
+- restricted: under moratorium and only accessible to logged-in data
+  owners/collaborators
+- unrestricted: publicly accessible without login and routinely
+  published to international biodiversity facilities
 
 The ETN infrastructure currently requires the package to be run within
 the [LifeWatch.be RStudio server](http://rstudio.lifewatch.be/), which
@@ -73,7 +77,7 @@ response %>%
     jsonlite::fromJSON(simplifyVector = TRUE)
 ```
 
-However, a branch of the [etn package](https://github.com/inbo/etn) is
+However, a fork of the [etn package](https://github.com/inbo/etn) is
 currently in development that will allow you to do this using built in
 functions.