Skip to content

Releases: inbo/checklist

Release v0.4.0

19 Jul 15:16
5649985
Compare
Choose a tag to compare

checklist 0.4.0

  • Updated README.md.
  • Improved support for organisation.
  • Add set_license().
  • check_filename() allows a CODEOWNERS file.
  • 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.

Release v0.3.6

30 May 11:32
d767206
Compare
Choose a tag to compare

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.
  • The output of the check shows the git diff (#77).
  • add_badges() helps to add badges to the README.
  • Put double quotes around the title and abstract fields of CITATION.cff.
  • check_documentation() handles assignment functions and re-exported functions
    correctly.
  • check_lintr() ignores renv subdirectories (#118).
  • Update to zen4R version 0.10 to
    reflect the Zenodo API changes (#125).
  • update_citation() no longer introduces new lines (#124) and handles single
    quotes in titles (#115).
  • 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.
  • check_spelling() handles leading or trailing backwards slashes (#107).
  • check_cran() ignores irrelevant CRAN notes.

Version 0.3.5

23 Jan 13:46
3413f5f
Compare
Choose a tag to compare
  • Fix release GitHub Action.
  • Bugfix in update_citation() on a DESCRIPTION.
  • check_spelling() handles Roxygen2 tags @aliases, @importMethodsFrom,
    @include, @keywords, @method, @name, @slot

Version 0.3.4

21 Jun 09:10
cef05b1
Compare
Choose a tag to compare
  • check_spelling() ignores numbers.
    * 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.

Version 0.3.3

07 Jun 09:26
2879d74
Compare
Choose a tag to compare
  • 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 vignette("folder", package = "checklist").

Release v0.3.2

08 May 06:56
a475267
Compare
Choose a tag to compare
  • citation_meta() gains support for bookdown reports.
  • 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.
  • setup_project() and create_project() provides support for renv.

Release v0.3.1

08 May 06:54
d3c2691
Compare
Choose a tag to compare
  • Fixes two bugs in case MIT license was chosen
  • GitHub Actions now uses the latest version of checklist as default when
    checking packages or projects.

Release v0.3.0

08 Mar 16:45
c1e200b
Compare
Choose a tag to compare
  • Improved create_project() and setup_project() which interactively guides
    the user through the set-up.
  • Add vignette("getting_started_project", package = "checklist").
  • Improved GitHub Actions.
    They use the built-in GITHUB_TOKEN.
    The user only needs to set the CODECOV_TOKEN in case of a package.
  • Fixes a note about "MIT" license.
  • The Dockerimage uses the same dictionaries as the local installation.
  • Add a German dictionary?
  • Spell check roxygen2 tags in .R files.
  • Don't spell check .Rd files generated by roxygen2.
  • check_cran() ignores Days since last update note.
  • 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.
  • Improved error messages for check_news().
  • check_source() is now deprecated.
    Use check_project() instead.
  • 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.
  • Store author information to reuse when running create_package() or
    create_project().
  • Add check_folder().

Release v0.2.6

14 Sep 13:43
b162fbd
Compare
Choose a tag to compare
# checklist 0.2.6

* `check_license()` allows `"MIT"` license in addition to `"GPLv3"` for packages

Release v0.2.5

14 Sep 09:12
226906a
Compare
Choose a tag to compare
# checklist 0.2.5

* Add spell checking functionality.
  See `vignette("spelling", package = "checklist")` for more details.
* The `checklist` class stores the required checks.
* Add `setup_project()` to set-up `checklist` on an existing project.
  This function allows the user to choose which checks to be required.
* Add `check_project()` to run the required checks of a project.
* Fix bug in `.zenodo.json` when only one keyword is present.