Skip to content

Commit b039c49

Browse files
authored
Merge pull request #74 from r-multiverse/166
Add check CI advice in contributors.md
2 parents 76661cd + c801c6c commit b039c49

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

contributors.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,20 @@ R-multiverse updates the [Production](production.qmd) repository in quarterly sn
8888
The [Production status page](https://r-multiverse.org/status/production.html) list the packages successfully staged for the next Production snapshot.
8989
Visit the [Production documentation](production.qmd) to learn how the process works.
9090

91+
## Checks
92+
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).
95+
96+
If you host your source code on GitHub, simply add a small workflow file to your package:
97+
98+
```r
99+
usethis::use_github_action(url = "https://github.com/r-multiverse/workflows/blob/main/examples/r-multiverse-staging.yaml")
100+
```
101+
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).
104+
91105
## Status
92106

93107
It is good practice to check the health of your contributed package using [R-multiverse status system](https://r-multiverse.org/status/index.html).

0 commit comments

Comments
 (0)