Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preparation for CRAN Release #38

Open
13 of 24 tasks
Martin-Jung opened this issue Mar 10, 2023 · 6 comments
Open
13 of 24 tasks

Preparation for CRAN Release #38

Martin-Jung opened this issue Mar 10, 2023 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@Martin-Jung
Copy link
Collaborator

Martin-Jung commented Mar 10, 2023

First release:

  • usethis::use_cran_comments()
  • Update (aspirational) install instructions in README
  • Proofread Title: and Description:
  • Check that all exported functions have @return and @examples
  • Check that Authors@R: includes a copyright holder (role 'cph')
  • Check licensing of included files
  • usethis::use_revdep()
  • Reverse dependency checks revdepcheck::revdep_check(num_workers = 4)
  • Review https://github.com/DavisVaughan/extrachecks

Prepare for release:

  • git pull
  • devtools::build_readme()
  • urlchecker::url_check()
  • devtools::check(remote = TRUE, manual = TRUE)
  • devtools::check_win_devel()
  • rhub::check_for_cran()
  • git push

Submit to CRAN:

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

Wait for CRAN...

  • Accepted 🎉
  • git push
  • usethis::use_github_release()
  • usethis::use_dev_version()
  • git push
@Martin-Jung Martin-Jung self-assigned this Mar 10, 2023
@Martin-Jung Martin-Jung changed the title Release ibis.iSDM 0.0.2 Preparation for CRAN Release Mar 10, 2023
@mhesselbarth
Copy link
Collaborator

Let me know if you need any help with this or have questions.

P.S. You dont need to run devtools::build_readme() anymore. Should be up-to-date due to the gh-action.

@Martin-Jung
Copy link
Collaborator Author

Let me know if you need any help with this or have questions.

P.S. You dont need to run devtools::build_readme() anymore. Should be up-to-date due to the gh-action.

Ohh, any help appreciated. I tried to fix a few things, but the MacOS R CMD check is still failing atm.
First I think we want version 0.0.2 to the main branch, but need to have the R checks working

@mhesselbarth
Copy link
Collaborator

Aren't all checks failing at the moment?

Okay, so the general roadmap would be fixing everything on dev (v0.0.2) first and then merging into master?

@mhesselbarth
Copy link
Collaborator

I lost a little bit track on what's still to do. Did you say you want to fix the remaining warnings about the documentation ?

@Martin-Jung
Copy link
Collaborator Author

Martin-Jung commented Jul 7, 2023

Yes, the main outstanding things are all the documentation warnings durings checks. I tried to fix some every now or then, but it is quite a lot...

@mhesselbarth
Copy link
Collaborator

There also are still (or again 😅 ) lots of NAMESPACE warnings about imports/suggests etc...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants