Skip to content

Commit

Permalink
Merge branch 'feat/setup-GHA' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
Claudius-Appel committed Apr 22, 2024
2 parents e8a7930 + 21c8e3a commit 966d728
Show file tree
Hide file tree
Showing 5 changed files with 150 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
^\.Rproj\.user$
^duflor-gui-private$
^dev$
^\.github$
^README\.Rmd$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
49 changes: 49 additions & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
@@ -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: [dev, dev_2]
pull_request:
branches: [main, master]

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: 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")'
52 changes: 52 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```

# duflor.gui

<!-- badges: start -->
[![R-CMD-check: Dev](https://github.com/Claudius-Appel/duflor.gui/actions/workflows/R-CMD-check.yaml/badge.svg?branch=dev)](https://github.com/Claudius-Appel/duflor.gui/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of duflor.gui is to ...

## Installation

You can install the development and release versions of `duflor.gui` like so:

``` r
# release
devtools::install_github("https://github.com/Claudius-Appel/duflor.gui@master")
# development
devtools::install_github("https://github.com/Claudius-Appel/duflor.gui@dev")
```

If help-vignettes are to be downloaded, use instead:

``` r
devtools::install_github("https://github.com/Claudius-Appel/duflor.gui@master"
,build_vignettes = T)
devtools::install_github("https://github.com/Claudius-Appel/duflor.gui@dev"
,build_vignettes = T)
```

Vignettes are rendered documents discussing specific topics within a package. Installing them is recommended, but not required for utilising the package itself.

### Prerequisites

Installing this package from GitHub requires the installation of the R-package `devtools`:

``` r
install.packages("devtools")
```
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# duflor.gui

<!-- badges: start -->

[![R-CMD-check:
Dev](https://github.com/Claudius-Appel/duflor.gui/actions/workflows/R-CMD-check.yaml/badge.svg?branch=dev)](https://github.com/Claudius-Appel/duflor.gui/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of duflor.gui is to …

## Installation

You can install the development and release versions of `duflor.gui`
like so:

``` r
# release
devtools::install_github("https://github.com/Claudius-Appel/duflor.gui@master")
# development
devtools::install_github("https://github.com/Claudius-Appel/duflor.gui@dev")
```

If help-vignettes are to be downloaded, use instead:

``` r
devtools::install_github("https://github.com/Claudius-Appel/duflor.gui@master"
,build_vignettes = T)
devtools::install_github("https://github.com/Claudius-Appel/duflor.gui@dev"
,build_vignettes = T)
```

Vignettes are rendered documents discussing specific topics within a
package. Installing them is recommended, but not required for utilising
the package itself.

### Prerequisites

Installing this package from GitHub requires the installation of the
R-package `devtools`:

``` r
install.packages("devtools")
```

0 comments on commit 966d728

Please sign in to comment.