Skip to content

Commit b6249fa

Browse files
more details on PR
1 parent afada19 commit b6249fa

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

vignettes/ci.Rmd

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ to use GitHub Actions. For existing repos, see below.
1818

1919
Next, we quickly introduce the two options. We recommend
2020
[pre-commit.ci](https://pre-commit.ci) unless your package has system
21-
dependencies that are not shipped with the R package on Linux **and** you want
22-
to use the [roxygenize hook](https://lorenzwalthert.github.io/precommit/dev/articles/available-hooks.html#roxygenize-1).
21+
dependencies that are not shipped with the R package on Linux
22+
**and at the same time** you want to use the
23+
[roxygenize hook](https://lorenzwalthert.github.io/precommit/dev/articles/available-hooks.html#roxygenize-1).
2324

2425

2526
## pre-commit.ci
@@ -45,7 +46,7 @@ to use the [roxygenize hook](https://lorenzwalthert.github.io/precommit/dev/arti
4546

4647
**Pros:**
4748

48-
- more flexible in how you run `pre-commit` if you need it.
49+
- more control over environment, e.g. system dependencies.
4950
- No new authentication needed.
5051
- If your package has system dependencies and you want to use the roxygenize
5152
hook, you can install them.
@@ -54,7 +55,11 @@ to use the [roxygenize hook](https://lorenzwalthert.github.io/precommit/dev/arti
5455

5556
- out-of-the-box action is in
5657
[maintenance only mode](https://github.com/pre-commit/action) and less
57-
feature complete than [pre-commit.ci](https://pre-commit.ci).
58+
feature complete than [pre-commit.ci](https://pre-commit.ci). For example,
59+
if your hooks fail on first attempt, the corrections are committed and pushed,
60+
but they won't trigger a new CI and you can't make them do it without
61+
[exposing credentials](https://github.com/pre-commit/action/pull/49). The only
62+
way is to close and re-open the PR.
5863
- You need to maintain the workflow file with a lot of boilerplate code and
5964
when GitHub changes the syntax, you need to adapt it to prevent failing
6065
builds.

0 commit comments

Comments
 (0)