Skip to content

Commit 61f2003

Browse files
Merge pull request #91 from ropensci/gha
modernize GHA workflow + update README + add Rproj
2 parents 660766d + 431ceb0 commit 61f2003

File tree

7 files changed

+122
-125
lines changed

7 files changed

+122
-125
lines changed

.Rbuildignore

+1
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ figure
1414
^cran-comments\.md$
1515
^\.httr-oauth$
1616
^codemeta\.json$
17+
^\.github$

.github/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

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

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
branches: [main, master]
8+
9+
name: R-CMD-check
10+
11+
jobs:
12+
R-CMD-check:
13+
runs-on: ${{ matrix.config.os }}
14+
15+
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
16+
17+
strategy:
18+
fail-fast: false
19+
matrix:
20+
config:
21+
- {os: macOS-latest, r: 'release'}
22+
- {os: windows-latest, r: 'release'}
23+
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
24+
- {os: ubuntu-latest, r: 'release'}
25+
- {os: ubuntu-latest, r: 'oldrel-1'}
26+
27+
env:
28+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
29+
R_KEEP_PKG_SOURCE: yes
30+
31+
steps:
32+
- uses: actions/checkout@v2
33+
34+
- uses: r-lib/actions/setup-pandoc@v2
35+
36+
- uses: r-lib/actions/setup-r@v2
37+
with:
38+
r-version: ${{ matrix.config.r }}
39+
http-user-agent: ${{ matrix.config.http-user-agent }}
40+
use-public-rspm: true
41+
42+
- uses: r-lib/actions/setup-r-dependencies@v2
43+
with:
44+
extra-packages: any::rcmdcheck
45+
needs: check
46+
47+
- uses: r-lib/actions/check-r-package@v2
48+
with:
49+
upload-snapshots: true

.github/workflows/R-check.yaml

-92
This file was deleted.

README.Rmd

+15-9
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
1-
gistr
2-
=======
1+
---
2+
output: github_document
3+
---
4+
5+
<!-- README.md is generated from README.Rmd. Please edit that file -->
36

4-
```{r echo=FALSE}
7+
```{r, include = FALSE}
58
knitr::opts_chunk$set(
6-
comment = "#>",
79
collapse = TRUE,
8-
warning = FALSE,
9-
message = FALSE
10+
comment = "#>",
11+
fig.path = "man/figures/README-",
12+
out.width = "100%"
1013
)
1114
```
1215

16+
gistr
17+
=======
18+
19+
<!-- badges: start -->
20+
[![R-CMD-check](https://github.com/ropensci/gistr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/gistr/actions/workflows/R-CMD-check.yaml)
1321
[![cran checks](https://cranchecks.info/badges/worst/gistr)](https://cranchecks.info/pkgs/gistr)
14-
[![R-check](https://github.com/ropensci/gistr/workflows/R-check/badge.svg)](https://github.com/ropensci/gistr/actions/)
1522
[![codecov.io](https://codecov.io/github/ropensci/gistr/coverage.svg?branch=master)](https://codecov.io/github/ropensci/gistr?branch=master)
1623
[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/gistr)](https://github.com/metacran/cranlogs.app)
1724
[![cran version](https://www.r-pkg.org/badges/version/gistr)](https://cran.r-project.org/package=gistr)
25+
<!-- badges: end -->
1826

1927
`gistr` is a light interface to GitHub's gists for R.
2028

@@ -50,5 +58,3 @@ library("gistr")
5058
* License: MIT
5159
* Get citation information for `gistr` in R doing `citation(package = 'gistr')`
5260
* Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.
53-
54-
[![rofooter](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org)

README.md

+36-24
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,63 @@
1-
gistr
2-
=======
31

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

4+
# gistr
55

6-
[![cran checks](https://cranchecks.info/badges/worst/gistr)](https://cranchecks.info/pkgs/gistr)
7-
[![R-check](https://github.com/ropensci/gistr/workflows/R-check/badge.svg)](https://github.com/ropensci/gistr/actions/)
6+
<!-- badges: start -->
7+
8+
[![R-CMD-check](https://github.com/ropensci/gistr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/gistr/actions/workflows/R-CMD-check.yaml)
9+
[![cran
10+
checks](https://cranchecks.info/badges/worst/gistr)](https://cranchecks.info/pkgs/gistr)
811
[![codecov.io](https://codecov.io/github/ropensci/gistr/coverage.svg?branch=master)](https://codecov.io/github/ropensci/gistr?branch=master)
9-
[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/gistr)](https://github.com/metacran/cranlogs.app)
10-
[![cran version](https://www.r-pkg.org/badges/version/gistr)](https://cran.r-project.org/package=gistr)
12+
[![rstudio mirror
13+
downloads](https://cranlogs.r-pkg.org/badges/gistr)](https://github.com/metacran/cranlogs.app)
14+
[![cran
15+
version](https://www.r-pkg.org/badges/version/gistr)](https://cran.r-project.org/package=gistr)
16+
<!-- badges: end -->
1117

12-
`gistr` is a light interface to GitHub's gists for R.
18+
`gistr` is a light interface to GitHubs gists for R.
1319

14-
Get started with the docs: https://docs.ropensci.org/gistr
20+
Get started with the docs: <https://docs.ropensci.org/gistr>
1521

1622
## See also:
1723

18-
* [gert](https://github.com/r-lib/gert) Simple git client for R by Jeroen Ooms
19-
* [gistfo](https://github.com/MilesMcBain/gistfo) for turning your untitled RStudio tabs into gists!
20-
* [git2r](https://github.com/ropensci/git2r) an R client for the libgit2 C library by Stefan Widgren
21-
* [git2rdata](https://ropensci.github.io/git2rdata/) for storing data frames efficiently in git
24+
- [git2r](https://github.com/ropensci/git2r) an R client for the
25+
libgit2 C library by Stefan Widgren
26+
- [gert](https://github.com/r-lib/gert) Simple git client for R by
27+
Jeroen Ooms
28+
- [gistfo](https://github.com/MilesMcBain/gistfo) for turning your
29+
untitled RStudio tabs into gists!
2230

2331
## Install
2432

2533
Stable version from CRAN
2634

27-
28-
```r
35+
``` r
2936
install.packages("gistr")
3037
```
3138

3239
Or dev version from GitHub.
3340

34-
35-
```r
41+
``` r
3642
remotes::install_github("ropensci/gistr")
3743
```
3844

39-
40-
```r
45+
``` r
4146
library("gistr")
47+
#>
48+
#> Attaching package: 'gistr'
49+
#> The following objects are masked from 'package:stats':
50+
#>
51+
#> embed, update
4252
```
4353

4454
## Meta
4555

46-
* Please [report any issues or bugs](https://github.com/ropensci/gistr/issues).
47-
* License: MIT
48-
* Get citation information for `gistr` in R doing `citation(package = 'gistr')`
49-
* Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.
50-
51-
[![rofooter](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org)
56+
- Please [report any issues or
57+
bugs](https://github.com/ropensci/gistr/issues).
58+
- License: MIT
59+
- Get citation information for `gistr` in R doing
60+
`citation(package = 'gistr')`
61+
- Please note that this package is released with a [Contributor Code
62+
of Conduct](https://ropensci.org/code-of-conduct/). By contributing
63+
to this project, you agree to abide by its terms.

gistr.Rproj

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Version: 1.0
2+
3+
RestoreWorkspace: Default
4+
SaveWorkspace: Default
5+
AlwaysSaveHistory: Default
6+
7+
EnableCodeIndexing: Yes
8+
UseSpacesForTab: Yes
9+
NumSpacesForTab: 2
10+
Encoding: UTF-8
11+
12+
RnwWeave: Sweave
13+
LaTeX: pdfLaTeX
14+
15+
AutoAppendNewline: Yes
16+
StripTrailingWhitespace: Yes
17+
18+
BuildType: Package
19+
PackageUseDevtools: Yes
20+
PackageInstallArgs: --no-multiarch --with-keep.source

0 commit comments

Comments
 (0)