Skip to content

Gh actions integration #914

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lorenzwalthert merged 1 commit into from
Feb 18, 2022
Merged

Gh actions integration #914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@

**Other changes**

* {styler} can be ran via GitHub Actions using
`usethis::use_github_action("style")` (#914).

* `.onLoad()` method no longer broken with {cli} >= 3.1 (#893).
* Piped function without brackets `substitute(x %>% y)` don't get `()` added
anymore for one level deep (not more yet, see #889), as this can change
Expand Down
9 changes: 7 additions & 2 deletions vignettes/third-party-integrations.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ knitr::opts_chunk$set(
styler functionality is available in other tools, most notably

* as a pre-commit hook `style-files` in
<https://github.com/lorenzwalthert/precommit>
<https://github.com/lorenzwalthert/precommit> to format before commit
(locally) and enforced as a continuous integration step in the cloud through
<https://pre-commit.ci>.

* via `usethis::use_tidy_style()` styles your project according to the tidyverse
style guide.
Expand All @@ -28,7 +30,10 @@ styler functionality is available in other tools, most notably
is used. The most convenient way to set this up is via
[`usethis::use_tidy_github_actions()`](https://usethis.r-lib.org/reference/tidyverse.html).

* as a formatter for RMarkdown without modifying the source. This feature is
* through the [GitHub Action Workflow](https://github.com/r-lib/actions/tree/v2-branch/examples#style-package) that triggers `styler::style_pkg()`
on changes in source files.

* as a formatter for R Markdown without modifying the source. This feature is
implemented as a code chunk option in knitr. use `tidy = "styler"` in the
header of a code chunks (e.g.` ```{r name-of-the-chunk, tidy = "styler"} `),
or `knitr::opts_chunk$set(tidy = "styler")` at the top of your RMarkdown
Expand Down