Skip to content

Commit ec04164

Browse files
authored
Merge pull request #75 from wlandau/main
use workflow dispatch for check workflow
2 parents b039c49 + 77918b9 commit ec04164

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@
33
.Rhistory
44
docs
55
.DS_Store
6+
7+
**/*.quarto_ipynb

contributors.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,17 +90,21 @@ Visit the [Production documentation](production.qmd) to learn how the process wo
9090

9191
## Checks
9292

93-
To help get your package into [Production](production.qmd), you can check each development commit against same versions of R and packages as in the [Staging universe](production.qmd).
94-
That way, when you create a new release of your package, you can be more confident that your package will pass [checks](production.qmd#checks).
93+
Before you release a new version of your package, you can check the development version in an environment that approximates [Staging](production.qmd).
94+
This will help you pass [checks](production.qmd#checks) and get into [Production](production.qmd).
9595

9696
If you host your source code on GitHub, simply add a small workflow file to your package:
9797

9898
```r
9999
usethis::use_github_action(url = "https://github.com/r-multiverse/workflows/blob/main/examples/r-multiverse-staging.yaml")
100100
```
101101

102-
Then commit that file to GitHub.
103-
From that point on, every commit will trigger a [GitHub Actions](https://github.com/features/actions) workflow that runs `R CMD check` in an environment that approximates [Staging](production.qmd).
102+
Then commit that file to GitHub, navigate to the "Actions" section of your repository, and run the `r-multiverse-staging` workflow:
103+
104+
![](./images/r-multiverse-staging.png)
105+
106+
`R CMD check` will run on Mac, Linux, and Windows.
107+
The workflow uses the same versions of base R and R packages that R-multiverse enforces in [Staging](production.qmd).
104108

105109
## Status
106110

images/r-multiverse-staging.png

107 KB
Loading

0 commit comments

Comments
 (0)