Skip to content

Release btw 1.0.0 #115

Closed
Closed

Description

@gadenbuie

First release:

Prepare for release:

  • git pull
  • Close v1.0.0 milestone
  • Advance deprecations, if needed
  • urlchecker::url_check()
  • devtools::build_readme()
  • devtools::check(remote = TRUE, manual = TRUE)
  • devtools::check_win_devel()
  • git push
  • Draft blog post

Submit to CRAN:

  • usethis::use_version('major')
  • devtools::submit_cran()
  • Approve email

Resubmit to CRAN:

  • Comments: No references to add in DESCRIPTION (authors (year) doi:... / authors (year, ISBN:...) / https:...)
  • Review examples:
    • Replace \dontrun{} with \donttest{} (only keep \dontrun{} if truly un-runnable)
    • Unwrap examples runnable in under 5 seconds or use \donttest{} instead of if(FALSE)
    • Ensure no code or examples write to user's home/package/getwd(); use tempdir() for tests/vignettes/examples
  • Remove installed.packages() usage
  • devtools::submit_cran()
  • Approve email

Wait for CRAN...

  • Accepted 🎉
  • Finish & publish blog post
  • Add link to blog post in pkgdown news menu
  • usethis::use_github_release()
  • usethis::use_dev_version(push = TRUE)
  • Share on social media
  • Slack link to blog post, bluesky, and linkedin in #open-source-comms

Activity

  1. added this to the v1.0.0 milestone on Oct 22, 2025
  2. simonpcouch commented on Oct 23, 2025

    @simonpcouch
    Collaborator

    it's lit

  3. gadenbuie commented on Oct 30, 2025

    @gadenbuie
    CollaboratorAuthor

    If there are references describing the methods in your package, please
    add these in the description field of your DESCRIPTION file in the form
    authors (year) doi:...
    authors (year, ISBN:...)
    or if those are not available: https:...
    with no space after 'doi:', 'https:' and angle brackets for
    auto-linking. (If you want to add a title as well please put it in
    quotes: "Title")
    For more details:
    https://contributor.r-project.org/cran-cookbook/description_issues.html#references

    \dontrun{} should only be used if the example really cannot be executed
    (e.g. because of missing additional software, missing API keys, ...) by
    the user. That's why wrapping examples in \dontrun{} adds the comment
    ("# Not run:") as a warning for the user. Does not seem necessary.
    Please replace \dontrun with \donttest.
    Please unwrap the examples if they are executable in < 5 sec, or replace
    dontrun{} with \donttest{}.
    Please never wrap examples is if(FALSE).
    For more details:
    https://contributor.r-project.org/cran-cookbook/general_issues.html#structuring-of-examples

    Please ensure that your functions do not write by default or in your
    examples/vignettes/tests in the user's home filespace (including the
    package directory and getwd()). This is not allowed by CRAN policies.
    Please omit any default path in writing functions. In your
    examples/vignettes/tests you can write to tempdir().
    For more details:
    https://contributor.r-project.org/cran-cookbook/code_issues.html#writing-files-and-directories-to-the-home-filespace

    You are using installed.packages() in your code. As mentioned in the
    notes of installed.packages() help page, this can be very slow.
    Therefore do not use installed.packages().
    "This needs to read several files per installed package, which will be
    slow on Windows and on some network-mounted file systems. It will be
    slow when thousands of packages are installed, so do not use it to find
    out if a named package is installed (use find.package or system.file)
    nor to find out if a package is usable (call requireNamespace or require
    and check the return value) nor to find details of a small number of
    packages (use packageDescription)." [installed.packages() help page]
    -> R/tool-session-package-installed.R; R/btw-package.R
    For more details:
    https://contributor.r-project.org/cran-cookbook/code_issues.html#calling-installed.packages

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions