Skip to content

Commit

Permalink
Merge pull request #541 from lorenzwalthert/rc-v0.4.0
Browse files Browse the repository at this point in the history
Release {precommit} 0.4.0
  • Loading branch information
lorenzwalthert authored Jan 21, 2024
2 parents 4f5ac61 + 9d27bc6 commit d9659eb
Show file tree
Hide file tree
Showing 14 changed files with 122 additions and 47 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@
^pkgdown$
^renv$
^renv\.lock$
^revdep$
^scratch$
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ repos:
inst/usethis-legacy-hook|
LICENSE|
renv/.*|
revdep/.*|
tests/testthat/in/.*|
)$
- id: readme-rmd-rendered
Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: precommit
Title: Pre-Commit Hooks
Version: 0.3.2.9028
Version: 0.4.0
Author: Lorenz Walthert
Maintainer: Lorenz Walthert <[email protected]>
Description: Useful git hooks for R building on top of the multi-language
Expand Down
91 changes: 53 additions & 38 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,74 @@
<!-- NEWS.md is maintained by https://fledge.cynkra.com, contributors should not edit this file -->
# precommit 0.4.0

# precommit 0.3.2.9020

- Make sorting consistent with spelling::update_wordlist (#514).
- Bump actions/checkout from 3 to 4 (#509).
- Discover and check for rogue print statements (#505).
- Use python 3.10 by default for conda envs(#477).
- Hook dependencies update (#503, #506 #508, #513).
Apart from two new hooks, many bug fixes and a few minor features, this release
focused on improving the user experience when installing the hooks, which caused
users the most troubles. We enabled fast hook installation without the need for build
time or system dependencies on all platforms thanks to the Posit Package Manager
and removal of dependencies {git2r} and {digest}.


# precommit 0.3.2.9015
**Features**

* Update dependencies.
* Refactored hook dependency update scripts.
* Please see tag diff for more details.
- New hook: `no-print-statement` discovers and check for rogue print
statements (#505).
- New hook: `pkgdown` runs `pkgdown::check_pkgdown()` to ensure the {pkgdown}
config is valid (#393).
- add Posit CRAN mirror to ensure macOS binary installs are possible (#488).
- `codemeta-description-updated`, `roxygenize`, and `use-tidy-description` now
all support a `root` argument that specifies the directory in the git repo
that contains the R package. Defaults to `.` since for most R package git
repos, the git and R package root coincide (#432, #438).
- `style-files` now supports styling of R code in Quarto docs (#449).
- `style-files` now supports file names with spaces (#516).
- Use python 3.10 by default for conda envs (#477).

# precommit 0.3.2.9013
**Bug Fixes**

* Don't depend on dev version of styler to avoid GitHub rate limit hit (#486).
- Make sorting consistent with `spelling::update_wordlist` (#514).
- Don't depend on dev version of styler to avoid GitHub rate limit hit (#486).
- fix roxygenize cache invalidation (#464, #520).
- fix missing namespace prefixing in roxygen hook (#525).

# precommit 0.3.2.9009

* add Posit CRAN mirror to ensure macOS binary installs are possible (#488).
* use `ubuntu-latest` instead of pinned version for tests (#481).
* correct typo (#465) and fix error message (#470).
* remove {digest} dependency (#471).
**Documentation**

- improve spelling (#453).
- `use_ci()` is now documented to take `NA`, not `NULL` for argument
`ci` (#431).
- correct typo (#465) and fix error message (#470).

**Dependencies**

- remove {digest} dependency (#471).
- remove {git2r} dependency (#497).
- Hook dependencies update (#503, #506 #508, #513, #540, #538, #527, #521, #519).

# precommit 0.3.2.9007 (2022-12-26)
**Infrastructure**

- roxygenize cache invalidation is functional again (#464).
- Refactored hook dependency update scripts and fixed bug with repos.
- Automatic hook dependency updates (#539, #532).
- use `ubuntu-latest` instead of pinned version for tests (#481).
- use new {pkgdown} hook in this repo (#460).
- `read-only` flag for testing (#529).
- Bump actions/checkout (#509, #458) and others (#533).
- ensure local and remote pre-commit execution are the same for this repo
(#463).
- use new pkgdown hook in this repo (#460).
- Use latest version of checkout action (#458).
- improve spelling (#453).

**Other**

# precommit 0.3.2.9003 (2022-12-16)
- Adjust to latest {roxygen2} CRAN release (#536).

- new hook `pkgdown` to emulate a {pkgdown} build for reference and
articles (#393).
- `codemeta-description-updated`, `roxygenize`, and
`use-tidy-description` now all support a `root` argument that
specifies the directory in the git repo that contains the R package.
Defaults to `.` since for most R package git repos, the git and R package
root coincide (#432, #438).
- `style-files` now supports styling of R code in Quarto docs (#449).

# precommit 0.3.2.9000
Changelog from dev releases is collapsed into this patch release at the time
this release is created. If you need releases by dev release, i.e. 0.3.2.x,
checkout this file at git tag `v0.3.2.9020`.

A big thanks goes to all people who made this release reality:

[&#x0040;AliSajid](https://github.com/AliSajid), [&#x0040;averissimo](https://github.com/averissimo), [&#x0040;clarkliming](https://github.com/clarkliming), [&#x0040;danielinteractive](https://github.com/danielinteractive), [&#x0040;denn173](https://github.com/denn173), [&#x0040;dependabot[bot]](https://github.com/dependabot), [&#x0040;EzicJ](https://github.com/EzicJ), [&#x0040;fabianegli](https://github.com/fabianegli), [&#x0040;hadley](https://github.com/hadley), [&#x0040;IndrajeetPatil](https://github.com/IndrajeetPatil), [&#x0040;jashapiro](https://github.com/jashapiro), [&#x0040;joelnitta](https://github.com/joelnitta), [&#x0040;jonathanckt](https://github.com/jonathanckt), [&#x0040;jsnel](https://github.com/jsnel), [&#x0040;kcphila](https://github.com/kcphila), [&#x0040;KoderKow](https://github.com/KoderKow), [&#x0040;KyleDCox](https://github.com/KyleDCox), [&#x0040;lorenzwalthert](https://github.com/lorenzwalthert), [&#x0040;m-muecke](https://github.com/m-muecke), [&#x0040;mythichamster](https://github.com/mythichamster), [&#x0040;ns-rse](https://github.com/ns-rse), [&#x0040;pre-commit-ci[bot]](https://github.com/pre-commit-ci), [&#x0040;russHyde](https://github.com/russHyde), [&#x0040;sempwn](https://github.com/sempwn), [&#x0040;stefanoborini](https://github.com/stefanoborini), [&#x0040;thefabnab](https://github.com/thefabnab), [&#x0040;TNonet](https://github.com/TNonet), [&#x0040;TymekDev](https://github.com/TymekDev), and [&#x0040;yogat3ch](https://github.com/yogat3ch).


- `use_ci()` is now documented to take `NA`, not `NULL` for argument
`ci` (#431).
- `deps-in-desc`supports a `root` argument that specifies the directory in
the git repo that contains the R package. Defaults to `.` since for most R
package git repos, the git and R package root coincide.

# precommit 0.3.2

Expand Down
2 changes: 1 addition & 1 deletion R/testing.R
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ not_conda <- function() {
#' @param git Whether or not to init git in the local directory.
#' @param autoupdate Whether or not to run [autoupdate()] as part of this
#' fixture.
#' @param use_precommmit Whether or not to [use_precommit()].
#' @param use_precommit Whether or not to [use_precommit()].
#' @keywords internal
local_test_setup <- function(git = TRUE,
use_precommit = FALSE,
Expand Down
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
editor_options:
markdown:
wrap: 72
---

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

Expand Down Expand Up @@ -42,11 +47,13 @@ The goal of this package is to twofold:
## Why do I need pre-commit hooks?

<figure>

<img src="man/figures/pre-commit-meme.jpeg" width="500" align="center" href="https://twitter.com/dataandme/status/1255510799273132032"/>
<figcaption>
By <a href=https://twitter.com/dataandme/status/1255510799273132032>Mara
Averick</a>
</figcaption>

<figcaption>By
<a href=https://twitter.com/dataandme/status/1255510799273132032>Mara
Averick</a></figcaption>

</figure>

For a more in-depth explanation and even more reasons, see
Expand Down
3 changes: 2 additions & 1 deletion cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
This is a submission due to changes in R devel.
This is a submission due to changes in roxygen2 7.3.0 and fixes also some issues
related to R devel changes.

## Test environments

Expand Down
1 change: 1 addition & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ behaviour
bioconductor
bliblablupp
cfe
Changelog
ci
CLI
cli
Expand Down
4 changes: 2 additions & 2 deletions man/local_test_setup.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions revdep/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
*.html
checks
checks.noindex
cloud.noindex
data.sqlite
library
library.noindex
34 changes: 34 additions & 0 deletions revdep/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Platform

|field |value |
|:--------|:------------------------------------------------------------------------------------------|
|version |R version 4.3.0 (2023-04-21) |
|os |macOS 14.2.1 |
|system |aarch64, darwin20 |
|ui |RStudio |
|language |(EN) |
|collate |en_US.UTF-8 |
|ctype |en_US.UTF-8 |
|tz |Europe/Zurich |
|date |2024-01-21 |
|rstudio |2023.12.0+369 Ocean Storm (desktop) |
|pandoc |3.1.1 @ /Applications/RStudio.app/Contents/Resources/app/quarto/bin/tools/ (via rmarkdown) |

# Dependencies

|package |old |new |Δ |
|:---------|:-----|:------|:--|
|precommit |0.3.2 |0.4.0 |* |
|cli |NA |3.6.2 |* |
|digest |NA |0.6.34 |* |
|glue |NA |1.7.0 |* |
|lifecycle |NA |1.0.4 |* |
|purrr |NA |1.0.2 |* |
|R.utils |NA |2.12.3 |* |
|rlang |NA |1.1.3 |* |
|rprojroot |NA |2.0.4 |* |
|vctrs |NA |0.6.5 |* |
|withr |NA |3.0.0 |* |
|yaml |NA |2.3.8 |* |

# Revdeps
6 changes: 6 additions & 0 deletions revdep/cran.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
## revdepcheck results

We checked 1 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.

* We saw 0 new problems
* We failed to check 0 packages
1 change: 1 addition & 0 deletions revdep/failures.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*Wow, no problems at all. :)*
1 change: 1 addition & 0 deletions revdep/problems.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*Wow, no problems at all. :)*

0 comments on commit d9659eb

Please sign in to comment.