Releases: inbo/checklist
Releases · inbo/checklist
Release v0.4.0
checklist 0.4.0
- Updated
README.md
. - Improved support for
organisation
. - Add
set_license()
. check_filename()
allows aCODEOWNERS
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
checklist 0.3.6
- Add an
organisation
class to store organisation rules different from those
of the Research Institute for Nature and Forest (INBO).
Seevignette("organisation", package = "checklist")
for more information. - The output of the check shows the git diff (#77).
add_badges()
helps to add badges to theREADME
.- Put double quotes around the title and abstract fields of
CITATION.cff
. check_documentation()
handles assignment functions and re-exported functions
correctly.check_lintr()
ignoresrenv
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 aDESCRIPTION
or the yaml of a
bookdown.
Use multiple footnotes is aREADME.md
. check_spelling()
handles leading or trailing backwards slashes (#107).check_cran()
ignores irrelevant CRAN notes.
Version 0.3.5
- Fix release GitHub Action.
- Bugfix in
update_citation()
on aDESCRIPTION
. check_spelling()
handles Roxygen2 tags@aliases
,@importMethodsFrom
,
@include
,@keywords
,@method
,@name
,@slot
Version 0.3.4
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 casecheck_lintr()
returns an error about global variables in a
function and you didrequire()
the package. - Fix release GitHub Action.
Version 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 forchecklist.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
citation_meta()
gains support forbookdown
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()
andcreate_project()
provides support forrenv
.
Release v0.3.1
- 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
- Improved
create_project()
andsetup_project()
which interactively guides
the user through the set-up. - Add
vignette("getting_started_project", package = "checklist")
. - Improved GitHub Actions.
They use the built-inGITHUB_TOKEN
.
The user only needs to set theCODECOV_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 byroxygen2
. check_cran()
ignoresDays 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.
Usecheck_project()
instead.- Parse
DESCRIPTION
(for a package) orREADME.md
(for a project) to extract
citation information into acitation_meta
object.
Then export this object into the different citation files. - Standardise the
DESCRIPTION
andREADME.md
to accommodate all citation
information.
DESCRIPTION
gainschecklist
specific settings like
Config/checklist/communities
andConfig/checklist/keywords
. - Store author information to reuse when running
create_package()
or
create_project()
. - Add
check_folder()
.
Release v0.2.6
# checklist 0.2.6 * `check_license()` allows `"MIT"` license in addition to `"GPLv3"` for packages
Release v0.2.5
# 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.