Remove travis and replace with GitHub Actions for R CMD check & pkgdown

coatless · coatless · commit 501314b37ca4 · 2025-05-26T19:26:21.000-07:00
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -5,3 +5,7 @@
 ^README-.*\.png$
 ^cran-comments\.md$
 ^codecov\.yml$
+^\.github$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
diff --git a/.github/.gitignore b/.github/.gitignore
@@ -0,0 +1 @@
+*.html
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -0,0 +1,33 @@
+# 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:
+
+name: R-CMD-check.yaml
+
+permissions: read-all
+
+jobs:
+  R-CMD-check:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          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/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -0,0 +1,49 @@
+# 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:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown.yaml
+
+permissions: read-all
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@
 .Ruserdata
 inst/doc
 .DS_Store
+docs
diff --git a/.travis.yml b/.travis.yml
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -11,9 +11,11 @@ Authors@R: c(
     )
 Description: Provides a set of user defined infix operators and functions with
     roots in other programming languages.
+URL: https://r-pkg.thecoatlessprofessor.com/rops/, https://github.com/coatless-rpkg/rops
+BugReports: https://github.com/coatless-rpkg/rops/issues
+License: MIT + file LICENSE
 Depends:
     R (>= 4.5.0)
-License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
 RoxygenNote: 7.3.2
diff --git a/README.Rmd b/README.Rmd
@@ -10,11 +10,10 @@ knitr::opts_chunk$set(
 )
 ```
 
+<!-- badges: start -->
 [![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
-[![Travis-CI Build Status](https://travis-ci.org/coatless/rops.svg?branch=master)](https://travis-ci.org/coatless/rops)
-[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/rops)](https://cran.r-project.org/package=rops)
-[![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/rops)](http://www.r-pkg.org/pkg/rops)
-[![Coverage Status](https://codecov.io/github/coatless/rops/master.svg)](https://codecov.io/github/coatless/rops?branch=master)
+[![R-CMD-check](https://github.com/coatless-rpkg/rops/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/coatless-rpkg/rops/actions/workflows/R-CMD-check.yaml)
+<!-- badges: end -->
 
 # R Ops (`rops`)
 
diff --git a/README.md b/README.md
@@ -1,25 +1,37 @@
 
-[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![Travis-CI Build Status](https://travis-ci.org/coatless/rops.svg?branch=master)](https://travis-ci.org/coatless/rops) [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/rops)](https://cran.r-project.org/package=rops) [![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/rops)](http://www.r-pkg.org/pkg/rops) [![Coverage Status](https://codecov.io/github/coatless/rops/master.svg)](https://codecov.io/github/coatless/rops?branch=master)
+<!-- badges: start -->
 
-R Ops (`rops`)
-==============
+[![Project Status: Active - The project has reached a stable, usable
+state and is being actively
+developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
+[![R-CMD-check](https://github.com/coatless-rpkg/rops/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/coatless-rpkg/rops/actions/workflows/R-CMD-check.yaml)
+<!-- badges: end -->
 
-The objective behind this package is to provide an extension to base *R* that supplements present operators manipulations.
+# R Ops (`rops`)
 
-![Demo of Operators](https://i.imgur.com/IGMeU0J.gif)
+The objective behind this package is to provide an extension to base *R*
+that supplements present operators manipulations.
 
-Supported Functionality
-=======================
+<figure>
+<img src="https://i.imgur.com/IGMeU0J.gif" alt="Demo of Operators" />
+<figcaption aria-hidden="true">Demo of Operators</figcaption>
+</figure>
+
+# Supported Functionality
 
 Presently, the package has support for the following operators:
 
--   [Null coalescing operator](https://en.wikipedia.org/wiki/Null_coalescing_operator): `%??%`
-    -   Operator to allow checking and substitution if a value is null without `if`/`else` structure
--   Missing value (`NA`) coalescing operator: `ifna(x, y)`
-    -   Substitute value when NA is detected.
--   [Is Whole Number](https://en.wikipedia.org/wiki/Integer): `is_whole(x)`
-    -   Vectorized boolean operator to assess whether value is an integer.
--   Safe Sequence Generation: `from %:% to`, `safe_seq(from, to, by)`
-    -   Create sequences that agree with the parity of the incrementer.
--   Not In Set: `x %notin% table`
-    -   Check to see if an element does not belong to a set.
+- [Null coalescing
+  operator](https://en.wikipedia.org/wiki/Null_coalescing_operator):
+  `%??%`
+  - Operator to allow checking and substitution if a value is null
+    without `if`/`else` structure
+- Missing value (`NA`) coalescing operator: `ifna(x, y)`
+  - Substitute value when NA is detected.
+- [Is Whole Number](https://en.wikipedia.org/wiki/Integer):
+  `is_whole(x)`
+  - Vectorized boolean operator to assess whether value is an integer.
+- Safe Sequence Generation: `from %:% to`, `safe_seq(from, to, by)`
+  - Create sequences that agree with the parity of the incrementer.
+- Not In Set: `x %notin% table`
+  - Check to see if an element does not belong to a set.
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -0,0 +1,4 @@
+url: https://r-pkg.thecoatlessprofessor.com/rops/
+template:
+  bootstrap: 5
+
diff --git a/codecov.yml b/codecov.yml
