Skip to content

CRAN submission of APCalign 2.1.0 #313

Open

Description

@dfalster

Submit the development version of APCalign to CRAN. This is the optional last step of #306, and AusTraits v8.0.0 doesn't depend on it.

Where things stand on 2026-11-15: CRAN has 2.0.1 (submitted 2026-09-09), and its check results are OK on every flavour. Master is 2.0.1.9000 at 55d95ac, with #300–#305, #308, #309 and #311 merged. No CRAN package depends on or suggests APCalign, so there are no reverse dependencies to check. The maintainer (cre) in DESCRIPTION is Elizabeth, so CRAN's confirmation email goes to her.

What the release contains (see NEWS.md for details): a new chars_changed output column; a summary printed by create_taxonomic_update_lookup(); aligned_reason now ends with the data version instead of the run date; hyphenated names are kept; several bug fixes (the version argument was ignored, the API rate limit, output files, names with no letters); and lighter dependencies (arrow replaced by nanoparquet; stringr, stringi and purrr dropped from Imports; readr moved to Suggests; crayon replaced by cli).

Steps

  • Version. Bump DESCRIPTION from 2.0.1.9000 to 2.1.0 (suggested: there are new features and output columns, and nothing exported is removed), and rename # APCalign (development version) in NEWS.md to # APCalign 2.1.0.
  • Vignette. vignettes/APCalign.Rmd is precomputed. Re-knit it from vignettes/APCalign.Rmd.orig with the new version installed (the command is at the top of the .orig), so the printed output shows chars_changed, the version suffix on aligned_reason and the lookup summary. Consider moving the .orig from version = "2024-10-11" to a recent snapshot such as 2026-11-15. Don't hand-edit the printed output.
  • Docs. Run devtools::document(). Check that there's no diff in man/ or NAMESPACE, and that the pkgdown site builds (pkgdown::build_site()).
  • Checks. Run urlchecker::url_check() and spelling::spell_check_package().
  • Local check. devtools::check(args = "--as-cran") must give 0 errors, 0 warnings and 0 notes. Run it once more offline (NETWORK_UP=FALSE): CRAN requires examples, tests and vignettes to fail gracefully without internet.
  • Remote checks. Run devtools::check_win_devel() and devtools::check_win_release() (the results come by email to the maintainer), and rhub::rhub_check() on Linux, macOS and Windows.
  • cran-comments.md. Rewrite it for 2.0.1 → 2.1.0: the check results, "no reverse dependencies", and a short summary of the changes, including the dependency changes.
  • Submit. Run devtools::submit_cran(), then confirm from the email sent to the maintainer. Commit the CRAN-SUBMISSION file that it writes.
  • After acceptance. Tag the accepted commit v2.1.0 and push the tag. Then bump to 2.1.0.9000 and add a new # APCalign (development version) heading to NEWS.md.

Do not create a GitHub Release for the package version

Push a git tag only. On CRAN 2.0.1, default_version() lists GitHub releases and stops with "Inconsistent date formats detected in versions!" if any release tag is neither a date nor a bare x.y.z. A release named v2.1.0 would break load_taxonomic_resources() for every user of 2.0.1 until they upgrade. Master no longer has this problem (#309), but the installed base does. A plain tag doesn't appear in the releases API.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

taskA discrete task needed for a feature

Projects

  • Status
    No status

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions