[INFRA] Add GitHub workflow to check the package (#25)

.Rbuildignore

@@ -0,0 +1,5 @@
+^\.github$
+^.*\.Rproj$
+^\.Rproj\.user$
+^CONTRIBUTING\.md$
+^LICENSE$

.github/.gitignore

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

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

@@ -0,0 +1,86 @@
+# Initially created by following https://orchid00.github.io/actions_sandbox/packageci.html#set-up-package
+# For help debugging build failures open an issue on the RStudio community with the 'github-actions' tag.
+# https://community.rstudio.com/new-topic?category=Package%20development&tags=github-actions
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+name: R-CMD-check
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: ubuntu-20.04, r: '3.6.3'}
+          - {os: ubuntu-20.04, r: '4.1.1'}
+
+    env:
+      R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
+      RSPM: https://packagemanager.rstudio.com/cran/__linux__/focal/latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: r-lib/actions/setup-r@v1
+        with:
+          r-version: ${{ matrix.config.r }}
+
+      - uses: r-lib/actions/setup-pandoc@v1
+
+      - name: Query dependencies
+        run: |
+          install.packages('remotes')
+          saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
+          writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
+        shell: Rscript {0}
+
+      - name: Restore R package cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ env.R_LIBS_USER }}
+          key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
+          restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
+
+      - name: Install system dependencies
+        if: runner.os == 'Linux'
+        run: |
+          while read -r cmd
+          do
+            eval sudo $cmd
+          done < <(Rscript -e 'writeLines(remotes::system_requirements("ubuntu", "20.04"))')
+
+      - name: Install dependencies
+        run: |
+          remotes::install_deps(dependencies = TRUE)
+          remotes::install_cran("rcmdcheck")
+        shell: Rscript {0}
+
+      - name: Check
+        env:
+          _R_CHECK_CRAN_INCOMING_REMOTE_: false
+        run: |
+          options(crayon.enabled = TRUE)
+          rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning", check_dir = "check")
+        shell: Rscript {0}
+
+      # TODO use when introducing tests (https://github.com/process-analytics/bpmn-visualization-R/issues/6)
+      # - name: Show testthat output
+      #   if: always()
+      #   run: find check -name 'testthat.Rout*' -exec cat '{}' \; || true
+      #   shell: bash
+
+      - name: Upload check results
+        if: failure()
+        uses: actions/upload-artifact@main
+        with:
+          name: ${{ matrix.config.os }}-r${{ matrix.config.r }}-results
+          path: check

DESCRIPTION

@@ -1,10 +1,11 @@
 Package: bpmnVisualization
 Type: Package
 Title: BPMN Visualization - R package
-Version: 1.0
-Date: 2021-08-25
-Authors@R: c(person("Céline Souchet", "Developer", role = c("aut", "cre"), email = "[email protected]"),
-             person("Thomas Bouffard", "Developer", role = "aut"))
-Description: A R package which embeds BPMN Visualization
-License: Apache-2.0
+Version: 0.1.0
+Authors@R: c(person("Celine", "Souchet", role = c("aut", "cre"), email = "[email protected]"),
+             person("Thomas", "Bouffard", role = "aut"))
+Description: A R package which embeds BPMN Visualization.
+License: Apache License (== 2)
 Copyright: Bonitasoft S.A.
+URL: https://github.com/process-analytics/bpmn-visualization-R
+BugReports: https://github.com/process-analytics/bpmn-visualization-R/issues

README.md

@@ -4,8 +4,8 @@
         <a href="https://github.com/process-analytics/bpmn-visualization-R/releases">
           <img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/process-analytics/bpmn-visualization-R?label=changelog&include_prereleases"> 
         </a>
-        <a href="https://github.com/process-analytics/bpmn-visualization-R/actions">
-          <img alt="Build" src="https://github.com/process-analytics/bpmn-visualization-R/workflows/Build/badge.svg"> 
+        <a href="https://github.com/process-analytics/bpmn-visualization-R/actions/workflows/R-CMD-check.yaml">
+          <img alt="Build" src="https://github.com/process-analytics/bpmn-visualization-R/workflows/R-CMD-check/badge.svg"> 
         </a>
         <br>
         <a href="CONTRIBUTING.md">

man/bpmnVisualization-package.Rd

@@ -24,9 +24,10 @@ Maintainer: \packageMaintainer{bpmnVisualization}
 \references{
 ~~ Literature or other references for background information ~~
 }
+\keyword{ 
 ~~ Optionally other standard keywords, one per line, from file KEYWORDS in ~~
 ~~ the R documentation directory ~~
-\keyword{ package }
+}
 \seealso{
 ~~ Optional links to other man pages, e.g. ~~
 ~~ \code{\link[<pkg>:<pkg>-package]{<pkg>}} ~~