The checklist summary displays the unstaged git changes.
The GitHub Action on packages installs the roxygen2 version listed in the DESCRIPTION of the package it checks.
checklist 0.3.6
Add an organisation class to store organisation rules different from those of the Research Institute for Nature and Forest (INBO). See vignette("organisation", package = "checklist") for more information.
You can add multiple affiliations per author (#123). Separate them by a semi-colon (;) in a DESCRIPTION or the yaml of a bookdown. Use multiple footnotes is a README.md.
Ask which GitHub organisation to use when create a new project. Default equals the organisation’s default.
GitHub Action for project allow to install package prior to checking the project. Use this in case check_lintr() returns an error about global variables in a function and you did require() the package.
Fix release GitHub Action.
checklist 0.3.3
New organisation() class to hold the requirements of the organisation. For the time being this is hard-coded to the Research Institute for Nature and Forest (INBO).
Author affiliations must match one of the affiliations set in organisation(). The membership of an author is determined by their e-mail or their affiliation. This is checked when creating or using author information and when updating citation information.
read_checklist() looks for checklist.yml in parent folders when it can’t find it in the provided path.
validate_orcid() checks the format and the checksum of the ORCID.
Add bookdown_zenodo() which first extracts the citation metadata from the yaml header. Then it cleans the output folder and renders the required output formats. Finally it uploads the rendered files to a draft deposit on Zenodo.
check_documentation() yields a warning when it find documented but unexported function. Use the @noRD tag in case you still want to document the function without exporting it.
Parse DESCRIPTION (for a package) or README.md (for a project) to extract citation information into a citation_meta object. Then export this object into the different citation files.
Standardise the DESCRIPTION and README.md to accommodate all citation information. DESCRIPTION gains checklist specific settings like Config/checklist/communities and Config/checklist/keywords.
create_package() gains a required language argument. This adds the required Language field to the DESCRIPTION.
checklist objects gain an update_keywords method. This is currently only relevant for packages. Usage: check your package with x <- check_package(). Add keywords with x$update_keywords(c("keyword 1", "keyword 2"). The method adds the keyword "R package" automatically. Store the keywords with write_checklist(x). Run update_citation() to update the citation files with the keywords. Use x$get_keywords() to retrieve the current keywords.
Improve the extraction of the DOI from the URL field.
check_cran() ignores the insufficient package version when checking the main branch. This required when checking an R package when the current version equals the latest version on CRAN.
check_environment() makes sure that the required repository secrets are set. check_package() performs this check when it runs in a GitHub Action. A missing repository secret results in an error. It points to vignette("getting_started") which indicates how to solve it.
create_package() replaces package name place holder with actual package name in _pkgdown.yml.
checklist 0.1.13
A new function update_citation() creates or updates a default citation in inst/CITATION.
When INBO is not listed as copyright holder, check_description() returns a warning rather than an error. This implies that you can motivate to ignore it via write_checklist(). (#33)
New new_branch() function to start a new branch from the most recent version of the main branch. This function will run clean_git() before creating the new branch.
check_package() runs the pkgdown::build_site() by default in interactive sessions. The function gains a pkgdown argument to turn of this behaviour.
Avoid false positive linters when .Rproj file is put under version control.
check_files() considers files with svg extensions as graphical files.
Minor bugfix in entrypoint_package.sh.
checklist 0.1.9
User visible changes
Many communities, both on GitHub and in the wider Git community, are considering renaming the default branch name of their repository from master. GitHub is gradually renaming the default branch of our own repositories from master to main. Therefore checklist now allows both a main or master branch as default. In case both are present, checklist uses main. Using only a master branch yields a note. Hence you must either which to a main branch or allow the note with write_checklist() (#44).
Bugfixes
Convert fancy single quotes to neutral single quotes (#42).
Drop the codemeta.json file. It requires constant updating as it contains a package file size.
checklist 0.1.5
check_documentation() allows NEWS.md to have level 2 headings (##) and single line subitems (*). It doesn’t count URLs when determining the line of a line. This allows lines to be longer than 80 characters due to long URLs.
