Releases: inbo/checklist
Releases · inbo/checklist
Release v0.2.4
# checklist 0.2.4 * `check_description()` enforces a `Language` field with a valid [ISO 639-3 code] (https://en.wikipedia.org/wiki/Wikipedia:WikiProject_Languages/List_of_ISO_639-3_language_codes_(2019)). * `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. * Allow `.rda` files in the `inst` folder of a package. * Allow back ticks around package name in `NEWS.md`. * Add `prepare_ghpages()`. * `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. * Define explicit which lintr options to use.
Release v0.2.3
# checklist 0.2.3 * Add `vignette("zenodo")` on how to set up the integration with [Zenodo](https://www.zenodo.org) and [ORCID](https://orcid.org) * `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. ## Bugfix * Fix problem in `write_zenodo_json()` which produced a `.zenodo.json` which failed to parse on https://zenodo.org. * `write_zenodo_json()` and `write_citation_cff()` return the checklist object and pass it to `update_citation()`.
Release v0.2.2
# checklist 0.2.2 ## Bugfix * Update URLS to [`lintr`](https://github.com/r-lib/lintr).
Release v0.1.14
# checklist 0.1.14 * Improve error message when changes in `CITATION` need to be commit. (#64) * `create_package()` can use maintainer information stored in the options. See `usethis::use_description()` on how to set the option. * Add R universe badges to README. * Add `write_zenodo_json()` and `write_citation_cff()`. * Improve the checklist Github Actions. ## Bugfix * `create_package()` replaces package name place holder with actual package name in `_pkgdown.yml`.
Release v0.1.13
# 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) * Ignore all `.Rd` files when running `check_filename()`. (#59) * `check_filename()` allows `R/sysdata.rda`. (#62)
Checklist 0.1.7
- Pushing to master should automatically create a release, using
set_tag()
. - Add a Zenodo DOI badge to the README and DOI URL to DESCRIPTION.
check_description()
now checks authors (#7).- INBO is set as copyright holder and funder.
- Every author has an ORCID.
setup_package()
adds the required files for apkgdown
website (#21).
checklist 0.1.6
- Drop the
codemeta.json
file. It requires constant updating as it contains a package file size.
Version 0.1.5
check_documentation()
allowsNEWS.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.check_filename()
is more liberal.- Allows files ending on
-package.Rd
. - Allows json or yml files starting with a dot and followed by letters.
- Allows filename
cran-comment.md
andWORDLIST
. - Allows
man-roxygen
as folder name. - Requires underscore (
_
) as separator for non-graphics files. - Requires dash (
-
) as separator for graphics files. - Basename separator issue are warnings instead of errors.
So you can allow these warnings viawrite_checklist()
.
- Allows files ending on
- Fix deploying pkgdown website and release.
- Package require a
codemeta.json
as written bycodemetar::write_codemeta
.
Suggestions bycodemetar
to improve the package become checklist notes. set_tag()
fails when in a detached HEAD state.set_tag()
creates a release when a tag is created on GitHub.check_cran()
ignores system time check when world clock API is not
available.check_license()
verifies the license information of a package.
This check is included viacheck_description()
incheck_package()
.
Version 0.1.4
# checklist 0.1.4 * `set_tag()` skips if the tag already exists. * `create_package()` sets a code of conduct and contributing guidelines. * `create_package()` sets `LICENSE.md`. * Run `pkgdown::build_site()` during the [`check_pkg`](https://github.com/inbo/actions/) GitHub action. * Deploy the `pkgdown` website to a `gp-pages` branch when pushing to master during the [`check_pkg`](https://github.com/inbo/actions/) GitHub action.
Version 0.1.3
Merge pull request #12 from inbo/tests Upgrade to version 0.1.3