|
1 | 1 | > Notes: the # between parenthesis refers to the related issue on GitHub, and the @ refers to an external contributor solving this issue.
|
2 | 2 |
|
3 |
| - |
4 | 3 | # golem 0.5.1 to 0.6.0
|
5 | 4 |
|
6 | 5 |
|
|
12 | 11 |
|
13 | 12 | ## Breaking change
|
14 | 13 |
|
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) |
16 | 17 |
|
17 | 18 | - 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.
|
18 | 19 |
|
19 | 20 | - 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 ) |
21 | 23 | - The file that the user tries to create already exists
|
22 | 24 |
|
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. |
24 | 26 |
|
25 | 27 | ## User visible change
|
26 | 28 |
|
|
44 | 46 |
|
45 | 47 | # golem 0.5.1
|
46 | 48 |
|
47 |
| -* Hotfixing a bug with utils_download_file (#1168) |
| 49 | +- Hotfixing a bug with utils_download_file (#1168) |
48 | 50 |
|
49 | 51 | # golem 0.5.0
|
50 | 52 |
|
51 | 53 | ## New functions
|
52 | 54 |
|
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) |
54 | 56 |
|
55 |
| -+ `use_readme_rmd()` adds a `{golem}` specific `README.Rmd` (@ilyaZar, #1011) |
| 57 | +- `use_readme_rmd()` adds a `{golem}` specific `README.Rmd` (@ilyaZar, #1011) |
56 | 58 |
|
57 |
| -+ rename `add_rstudioconnect_file()` to `add_positconnect_file()` (@ilyaZar, #1017) |
| 59 | +- rename `add_rstudioconnect_file()` to `add_positconnect_file()` (@ilyaZar, #1017) |
58 | 60 |
|
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) |
60 | 62 |
|
61 |
| -+ `add_r6()` adds an empty R6 file (@ilyaZar, #1009) |
| 63 | +- `add_r6()` adds an empty R6 file (@ilyaZar, #1009) |
62 | 64 |
|
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) |
64 | 66 |
|
65 |
| -+ Defunct usethis functions has been removed from dev.R (@ilyaZar, #1125) |
| 67 | +- Defunct usethis functions has been removed from dev.R (@ilyaZar, #1125) |
66 | 68 |
|
67 | 69 | ## New features / user visible changes
|
68 | 70 |
|
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) |
70 | 72 |
|
71 |
| -+ allow for user supplied `run_dev`-files (#886, @ilyaZar) |
| 73 | +- allow for user supplied `run_dev`-files (#886, @ilyaZar) |
72 | 74 |
|
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) |
74 | 76 |
|
75 |
| -+ `a_start`-vignette has updated documentation (#1046, @ilyaZar) |
| 77 | +- `a_start`-vignette has updated documentation (#1046, @ilyaZar) |
76 | 78 |
|
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) |
78 | 80 |
|
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) |
80 | 82 |
|
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) |
82 | 84 |
|
83 |
| -+ `add_fct()` now adds the skeleton for a function (#1004, @ilyaZar) |
| 85 | +- `add_fct()` now adds the skeleton for a function (#1004, @ilyaZar) |
84 | 86 |
|
85 |
| -+ The module skeleton now stick to tidyverse style (#1019, @ni2scmn) |
| 87 | +- The module skeleton now stick to tidyverse style (#1019, @ni2scmn) |
86 | 88 |
|
87 |
| -+ Better comments to `fill_desc()` in `01_start.R` (#1021, @ilyaZar) |
| 89 | +- Better comments to `fill_desc()` in `01_start.R` (#1021, @ilyaZar) |
88 | 90 |
|
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) |
90 | 92 |
|
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) |
92 | 94 |
|
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) |
94 | 96 |
|
95 |
| -+ Adding `writeManifest()` to `deploy.R` (#1063, @ilyaZar) |
| 97 | +- Adding `writeManifest()` to `deploy.R` (#1063, @ilyaZar) |
96 | 98 |
|
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)) |
98 | 100 |
|
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 |
100 | 102 |
|
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. |
102 | 104 |
|
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) |
104 | 106 |
|
105 | 107 | ## Bug fixes
|
106 | 108 |
|
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) |
108 | 110 |
|
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) |
110 | 112 |
|
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) |
112 | 114 |
|
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) |
114 | 116 |
|
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) |
116 | 118 |
|
117 |
| -+ `{attachment}` now has a minimum version requirement (#1104, @ilyaZar) |
| 119 | +- `{attachment}` now has a minimum version requirement (#1104, @ilyaZar) |
118 | 120 |
|
119 |
| -+ `{pkgload}` now has a minimum version requirement (#1106) |
| 121 | +- `{pkgload}` now has a minimum version requirement (#1106) |
120 | 122 |
|
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 |
122 | 124 |
|
123 | 125 | ## Internal changes
|
124 | 126 |
|
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) |
126 | 128 |
|
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) |
128 | 130 |
|
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) |
130 | 132 |
|
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. |
132 | 134 |
|
133 | 135 | # 0.4.1
|
134 | 136 |
|
@@ -166,7 +168,7 @@ This is an intermediate release after CRAN feedback.
|
166 | 168 |
|
167 | 169 | ## Internal changes
|
168 | 170 |
|
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 |
170 | 172 |
|
171 | 173 | # golem 0.3.5
|
172 | 174 |
|
|
0 commit comments