Skip to content

Commit 7885ffe

Browse files
Merge branch 'master' into compact_dockerfile
2 parents 381a935 + 00fc0e2 commit 7885ffe

File tree

128 files changed

+12727
-9339
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

128 files changed

+12727
-9339
lines changed

.Rbuildignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,6 @@ README.html
2727
^dev$
2828
^pkgdown$
2929
^\.pre-commit-config\.yaml$
30+
^[\.]?air\.toml$
31+
^\.vscode$
32+
^\.lintr$

.github/workflows/format-suggest.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Workflow derived from https://github.com/posit-dev/setup-air/tree/main/examples
2+
on:
3+
pull_request:
4+
5+
name: format-suggest.yaml
6+
7+
permissions: read-all
8+
9+
jobs:
10+
format-suggest:
11+
name: format-suggest
12+
runs-on: ubuntu-latest
13+
permissions:
14+
pull-requests: write
15+
steps:
16+
- uses: actions/checkout@v4
17+
18+
- name: Install
19+
uses: posit-dev/setup-air@v1
20+
21+
- name: Format
22+
run: air format .
23+
24+
- name: Suggest
25+
uses: reviewdog/action-suggester@v1
26+
with:
27+
level: error
28+
fail_level: error
29+
tool_name: air

.lintr

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
linters: linters_with_defaults(
2+
defaults = default_linters,
3+
whitespace_linter = NULL,
4+
indentation_linter = indentation_linter(
5+
indent = 1L,
6+
)
7+
)

.vscode/extensions.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"recommendations": [
3+
"Posit.air-vscode"
4+
]
5+
}

.vscode/settings.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"[r]": {
3+
"editor.formatOnSave": true,
4+
"editor.defaultFormatter": "Posit.air-vscode"
5+
}
6+
}

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: golem
22
Title: A Framework for Robust Shiny Applications
3-
Version: 0.5.1.9011
3+
Version: 0.5.1.9012
44
Authors@R: c(
55
person("Colin", "Fay", , "contact@colinfay.me", role = c("cre", "aut"),
66
comment = c(ORCID = "0000-0001-7343-1846")),

NEWS.md

Lines changed: 45 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
> Notes: the # between parenthesis refers to the related issue on GitHub, and the @ refers to an external contributor solving this issue.
22
3-
43
# golem 0.5.1 to 0.6.0
54

65

@@ -12,15 +11,18 @@
1211

1312
## Breaking change
1413

15-
- /!\ Breaking change in the name of the arguments /!\ `{golem}` functions used to rely on arguments that where either `wd`, `path`, `pkg` or `golem_wd`. This has now been standardized and all functions rely on `golem_wd` now (@ilyaZar, #845)
14+
- The `get_current_config()` has been rework in two ways: (1) it nows either check the `GOLEM_CONFIG_PATH` env var or the default path (inst/golem-config.yml). `{golem}` no longer tries to guess non standard paths, and does a hard fail if the file doesn't exist, (2) the function no longer copy the `config` files from the skeleton if ever the files are not there (@ilyaZar, @LDSamson, #1178)
15+
16+
- `{golem}` functions used to rely on arguments that where either `wd`, `path`, `pkg` or `golem_wd`. This has now been standardized and all functions rely on `golem_wd` now (@ilyaZar, #845)
1617

1718
- Creating a `golem` doesn't call `set_here()` nor `usethis::create_project()` anymore. It used to be because we wanted to be able to use `here::here()`, but the function should be able to find its way based using `DESCRIPTION`. It gives a lighter implementation of golem projects creation as it doesn't mess up with where `here()` is anymore.
1819

1920
- The `add_*_files` and `use_*_files` now fail when:
20-
- The directory where the user tries to add the file doesn't exist. `{golem}` used to try to create the directory but that's not the function job — use_*_file functions should only be there to add file (Singe responsabily )
21+
22+
- The directory where the user tries to add the file doesn't exist. `{golem}` used to try to create the directory but that's not the function job — use\_\*\_file functions should only be there to add file (Singe responsabily )
2123
- The file that the user tries to create already exists
2224

23-
- Creating a golem with `create_golem(overwrite = TRUE)` will now __delete the old folder__ and replace with the golem skeleton.
25+
- Creating a golem with `create_golem(overwrite = TRUE)` will now **delete the old folder** and replace with the golem skeleton.
2426

2527
## User visible change
2628

@@ -44,91 +46,91 @@
4446

4547
# golem 0.5.1
4648

47-
* Hotfixing a bug with utils_download_file (#1168)
49+
- Hotfixing a bug with utils_download_file (#1168)
4850

4951
# golem 0.5.0
5052

5153
## New functions
5254

53-
+ `is_golem()` tries to guess if the current folder is a `{golem}`-based app (#836)
55+
- `is_golem()` tries to guess if the current folder is a `{golem}`-based app (#836)
5456

55-
+ `use_readme_rmd()` adds a `{golem}` specific `README.Rmd` (@ilyaZar, #1011)
57+
- `use_readme_rmd()` adds a `{golem}` specific `README.Rmd` (@ilyaZar, #1011)
5658

57-
+ rename `add_rstudioconnect_file()` to `add_positconnect_file()` (@ilyaZar, #1017)
59+
- rename `add_rstudioconnect_file()` to `add_positconnect_file()` (@ilyaZar, #1017)
5860

59-
+ `add_empty_file` creates an empty file in the www directory (#837)
61+
- `add_empty_file` creates an empty file in the www directory (#837)
6062

61-
+ `add_r6()` adds an empty R6 file (@ilyaZar, #1009)
63+
- `add_r6()` adds an empty R6 file (@ilyaZar, #1009)
6264

63-
+ `golem::welcome_page()` now display a page on default scaffold app (#1126)
65+
- `golem::welcome_page()` now display a page on default scaffold app (#1126)
6466

65-
+ Defunct usethis functions has been removed from dev.R (@ilyaZar, #1125)
67+
- Defunct usethis functions has been removed from dev.R (@ilyaZar, #1125)
6668

6769
## New features / user visible changes
6870

69-
+ sourcing `dev/01_start.R` leaves the file in a clean state with all files added to the initial commit (#1094, @ilyaZar)
71+
- sourcing `dev/01_start.R` leaves the file in a clean state with all files added to the initial commit (#1094, @ilyaZar)
7072

71-
+ allow for user supplied `run_dev`-files (#886, @ilyaZar)
73+
- allow for user supplied `run_dev`-files (#886, @ilyaZar)
7274

73-
+ `README` is re-styled and links to various external resources of the `golemverse` (#1064, @ilyaZar)
75+
- `README` is re-styled and links to various external resources of the `golemverse` (#1064, @ilyaZar)
7476

75-
+ `a_start`-vignette has updated documentation (#1046, @ilyaZar)
77+
- `a_start`-vignette has updated documentation (#1046, @ilyaZar)
7678

77-
+ `fill_desc()` automatically calls `set_options()`; see `dev/01_start.R` as well (#1040, @ilyaZar)
79+
- `fill_desc()` automatically calls `set_options()`; see `dev/01_start.R` as well (#1040, @ilyaZar)
7880

79-
+ `fill_desc()` now uses a `person` vector (#1027, @jmeyer2482, @ColinFay and @ilyaZar)
81+
- `fill_desc()` now uses a `person` vector (#1027, @jmeyer2482, @ColinFay and @ilyaZar)
8082

81-
+ `use_{internal,external}_XXX_file()` function family has improved error handling for non-interactive usage (#1062, @ilyaZar)
83+
- `use_{internal,external}_XXX_file()` function family has improved error handling for non-interactive usage (#1062, @ilyaZar)
8284

83-
+ `add_fct()` now adds the skeleton for a function (#1004, @ilyaZar)
85+
- `add_fct()` now adds the skeleton for a function (#1004, @ilyaZar)
8486

85-
+ The module skeleton now stick to tidyverse style (#1019, @ni2scmn)
87+
- The module skeleton now stick to tidyverse style (#1019, @ni2scmn)
8688

87-
+ Better comments to `fill_desc()` in `01_start.R` (#1021, @ilyaZar)
89+
- Better comments to `fill_desc()` in `01_start.R` (#1021, @ilyaZar)
8890

89-
+ `01_start.R` now has a call to `usethis::use_git_remote()` (#1015, @ilyaZar)
91+
- `01_start.R` now has a call to `usethis::use_git_remote()` (#1015, @ilyaZar)
9092

91-
+ Tests for `R/golem_utils_server.R` and `R/golem_utils_ui.R` now have full code coverage (#1020, @ilyaZar)
93+
- Tests for `R/golem_utils_server.R` and `R/golem_utils_ui.R` now have full code coverage (#1020, @ilyaZar)
9294

93-
+ When setting a new name, `{golem}` now browses tests & vignettes (#805, @ilyaZar)
95+
- When setting a new name, `{golem}` now browses tests & vignettes (#805, @ilyaZar)
9496

95-
+ Adding `writeManifest()` to `deploy.R` (#1063, @ilyaZar)
97+
- Adding `writeManifest()` to `deploy.R` (#1063, @ilyaZar)
9698

97-
+ `use_git()` is now at the bottom of 01_dev.R ((#1094, @ilyaZar))
99+
- `use_git()` is now at the bottom of 01_dev.R ((#1094, @ilyaZar))
98100

99-
+ `golem::add_dockerfile_with_renv_*()` set "rstudio" as default USER in Dockerfile to avoid launching app as root
101+
- `golem::add_dockerfile_with_renv_*()` set "rstudio" as default USER in Dockerfile to avoid launching app as root
100102

101-
+ It is now easier to modify the renv.config.pak.enabled parameter in the Dockerfile generated by `golem::add_dockerfile_with_renv_*()` functions.
103+
- It is now easier to modify the renv.config.pak.enabled parameter in the Dockerfile generated by `golem::add_dockerfile_with_renv_*()` functions.
102104

103-
+ We create an `.rscignore` in the golem dir whenever creating the connect related file (#110, @ilyaZar)
105+
- We create an `.rscignore` in the golem dir whenever creating the connect related file (#110, @ilyaZar)
104106

105107
## Bug fixes
106108

107-
+ `use_{internal,external}_XXX_file()` function family works with default missing `name` argument (#1060, @ilyaZar)
109+
- `use_{internal,external}_XXX_file()` function family works with default missing `name` argument (#1060, @ilyaZar)
108110

109-
+ `run_dev()` now install needed dependencies to source `dev/run_dev.R` if needed (#942, @ilyaZar, @vincentGuyader)
111+
- `run_dev()` now install needed dependencies to source `dev/run_dev.R` if needed (#942, @ilyaZar, @vincentGuyader)
110112

111-
+ `use_readme_rmd()` does not pop up when argument `open=FALSE` is set (#1044, @ilyaZar)
113+
- `use_readme_rmd()` does not pop up when argument `open=FALSE` is set (#1044, @ilyaZar)
112114

113-
+ Docker commands now take the `-it` flag so it can be killed with `^C` (#1002, @ivokwee)
115+
- Docker commands now take the `-it` flag so it can be killed with `^C` (#1002, @ivokwee)
114116

115-
+ `add_module()` now behaves correctly when trying to use `mod_mod_XXX` and no longer opens an interactive menu (#997, @ilyaZar)
117+
- `add_module()` now behaves correctly when trying to use `mod_mod_XXX` and no longer opens an interactive menu (#997, @ilyaZar)
116118

117-
+ `{attachment}` now has a minimum version requirement (#1104, @ilyaZar)
119+
- `{attachment}` now has a minimum version requirement (#1104, @ilyaZar)
118120

119-
+ `{pkgload}` now has a minimum version requirement (#1106)
121+
- `{pkgload}` now has a minimum version requirement (#1106)
120122

121-
+ `create_golem()` can be now used with path = "." and package_name empty
123+
- `create_golem()` can be now used with path = "." and package_name empty
122124

123125
## Internal changes
124126

125-
+ Add tests for (under/un)-tested files and functions and improve code coverage of `{golem}` (#1043, #1050, #1059, #1066, #1075, @ilyaZar)
127+
- Add tests for (under/un)-tested files and functions and improve code coverage of `{golem}` (#1043, #1050, #1059, #1066, #1075, @ilyaZar)
126128

127-
+ `guess_where_config()` now finds the user config-yaml by reading its new location from user changes in "R/app_config.R" (#887, @ilyaZar)
129+
- `guess_where_config()` now finds the user config-yaml by reading its new location from user changes in "R/app_config.R" (#887, @ilyaZar)
128130

129-
+ All functions that require to get a path now rely on `get_golem_wd()` (#1016, @ilyaZar)
131+
- All functions that require to get a path now rely on `get_golem_wd()` (#1016, @ilyaZar)
130132

131-
+ The test suite has been refactored and is now silent and faster.
133+
- The test suite has been refactored and is now silent and faster.
132134

133135
# 0.4.1
134136

@@ -166,7 +168,7 @@ This is an intermediate release after CRAN feedback.
166168

167169
## Internal changes
168170

169-
+ `add_dockerfile_with_renv` now works well with uppercase in package name
171+
- `add_dockerfile_with_renv` now works well with uppercase in package name
170172

171173
# golem 0.3.5
172174

0 commit comments

Comments
 (0)