Changelog
Source:NEWS.md
rcompendium 1.3.9000 (development version)
-
Bug fixes
-
add_sticker()
copies the sticker template infigures/readme/
and no more inman/figures/
(listed in the.gitignore
)
-
-
Minor changes
- Remove dependency to
crayon
andclisymbols
in favor ofcli
- Improve templates
-
add_compendium()
does not create subfolders indata/
- Remove dependency to
rcompendium 1.3
CRAN release: 2023-10-26
-
Bug fixes
-
get_deps_*()
better detects project dependencies and does not delete packages called w/library("pkg")
orlibrary('pkg')
-
add_sticker()
now copies the sticker template for compendium
-
-
Minor changes
- Provide instructions for installing V8 engine on Unix systems
rcompendium 1.2
CRAN release: 2023-10-24
-
New features
-
get_git_branch_name()
detects git branch name -
add_contributing()
adds aCONTRIBUTING.md
file and issue templates -
add_code_of_conduct()
adds aCODE_OF_CONDUCT.md
file -
add_github_actions_citation()
adds a new GitHub action to update theCITATION.cff
file -
add_github_actions_document()
adds a new GitHub action to updateRd
files, theNAMESPACE
and theDESCRIPTION
files
-
-
Improvements
-
get_deps_*()
better detects project dependencies -
add_compendium()
allows now the user to choose its own compendium structure
-
-
Minor changes
- Update GitHub Actions templates (
yaml
files) - Update README templates
- The
man/
folder andNAMESPACE
are now untracked by git (for compendium only) - Remove dependencies badge in README
- Change default values of
lifecycle
andstatus
arguments innew_package()
- Change commit messages in
new_*()
functions (conventional commits)
- Update GitHub Actions templates (
-
Deprecated
-
refresh()
is now deprecated and will be deleted in the new version
-
rcompendium 1.1
CRAN release: 2023-04-24
- Update GitHub Actions templates (
yaml
files) - Detect current git branch name in
add_readme_rmd()
- Ignore
renv
files (R build and GitHub) inadd_renv()
rcompendium 1.0
CRAN release: 2022-04-06
- New feature:
add_dockerfile()
creates a basicDockerfile
in compendium (new argumentdokerfile
innew_compendium()
) based onrocker/rstudio
. - New feature:
add_renv()
initializerenv
environment in compendium (new argumentrenv
innew_compendium()
) - New feature:
add_github_actions_render()
will automatically render theREADME.md
on GitHub server after each push. This action is triggered only if theREADME.Rmd
has been modified since the last commit. Also add new argumentgh_render
innew_*()
functions. - New vignette: developing an R package
- New vignette: working with a compendium
- Function
add_dependencies()
allows now missingR/
folder and improves the detection of dependencies in vignettes. - Function
add_lifecycle_badge()
does not copy badge SVG in the project anymore. The image badge is now created using https://shields.io/. - Update GHA templates. They are now derived from: https://github.com/r-lib/actions/tree/v2-branch/examples
- Rename default vignette title (title is now Get Started)
- Add
cph
(copyright holder) tag inDESCRIPTION
file - Change default package hexSticker and add R script in
inst/package-sticker/
to easily change the hexSticker - Rename commits messages (and remove emoji)
- For compendium: arguments
gh_check
andwebsite
are nowFALSE
by default - For compendium: rename
rscripts/
folder toanalyses/
- For compendium: delete
paper/
folder - Review and improve documentation
- Rename templates file names
- Fix bug: detection of nested RStudio projects
rcompendium 0.5.1
CRAN release: 2021-03-24
After first submission to CRAN:
-
DESCRIPTION
file: replace “The aim of the package ‘rcompendium’ is to make easier…” by “Makes easier…” - Function
set_credentials()
does not write the.Rprofile
file anymore (not allowed by CRAN policies). Instead this function opens this file and users need to manually paste the content of the clipboard. - Replace
utils::installed.packages()
byfind.package()
rcompendium 0.5
- Check for valid package name
- Add new features:
new_compendium()
andadd_compendium()
- Allow adding to
.gitignore
and.Rbuildignore
several names - Improve console messages
- Modify templates
rcompendium 0.4
- New features:
add_testthat()
,add_github_actions_codecov()
,add_github_actions_codecov_badge()
, andadd_codecov_badge()
- New arguments in
new_package()
:test
andcodecov
- Add a demo R function to pass test and show good practices in writing functions
rcompendium 0.3
- Improve dependencies detection in
@examples
sections - Keep packages versions in
DESCRIPTION
fields - Retrieve GitHub pseudo with
gh::gh_whoami()
(no moregithub
argument)
rcompendium 0.2
- Rename
import
argument intocompendium
- Automatically check dependencies in
vignettes/
(remove argumentsuggest
) - Detect dependencies in
tests/
- Add new internal function
path_proj()
- Use
usethis::proj_get()
instead ofhere::here()
- Rename
add_github_badge()
inadd_github_actions_check_badge()
- Add new function
add_github_actions_pkgdown_badge()
- Badge functions return now Markdown badges (if assigned to a variable)
- Badges are added at the end of the process (adding a additional commit)
- Change default license in
new_package()
- Improve inputs checks
- Change files templates (GH Actions names)