协作头脑风暴
brainstorming
在实现前澄清需求、探索设计选择,并形成清晰的开发方向。
submit-to-cran【开发与工程】Complete procedure for submitting an R package to CRAN, including pre-submission checks (local, win-builder, R-hub), cran-comments.md preparation, URL and spell checking, and the submission itself. Covers first submissions and updates. Use when a package is ready for initial CRAN release, when submitting an updated version of an existing CRAN package…
独立 GitHub 快照 · 自动分类 · 以原作者文档为准
行全 CRAN 投流——自前察至投。
R CMD check 0 誤 0 警之 R 包驗 DESCRIPTION 版正:
desc::desc_get_version()
驗 NEWS.md 有此版項。項當總用面之改。
得:版合語意。NEWS.md 含配項。
敗:以 usethis::use_version() 更版(擇 "major"、"minor"、"patch")。加 NEWS.md 項總用面之改。
devtools::check()
得:0 誤、0 警、0 注(首投可 1 注「New submission」)。
敗:諸誤警先正乃進。讀 <pkg>.Rcheck/00check.log 詳。注於 cran-comments.md 釋。
devtools::spell_check()
正詞加 inst/WORDLIST(一行一詞、字母序)。
得:無異拼。諸標詞或正或加 inst/WORDLIST。
敗:正真拼誤。正技詞加 inst/WORDLIST(一行一詞、字母序)。
urlchecker::url_check()
得:諸 URL 返 HTTP 200。無斷或重定向。
敗:換斷 URL。DOI 用 \doi{} 而非原 URL。除已不存資。
devtools::check_win_devel()
devtools::check_win_release()
待郵果(常 15-30 分)。
得:Win-builder release 與 devel 皆 0 誤 0 警。果於 15-30 分內郵至。
敗:理臺特問。常因:異編譯警、缺系依、路分隔差。本地正而再投 Win-builder。
rhub::rhub_check()
此察多臺(Ubuntu、Windows、macOS)。
得:諸臺皆過 0 誤 0 警。
敗:某臺敗→察 R-hub 構日為臺特誤。為臺依為用 testthat::skip_on_os() 或條件碼。
於包根建或更 cran-comments.md:
## R CMD check results
0 errors | 0 warnings | 1 note
* This is a new release.
## Test environments
* local: Windows 11, R 4.5.0
* win-builder: R-release, R-devel
* R-hub: ubuntu-latest (R-release), windows-latest (R-release), macos-latest (R-release)
## Downstream dependencies
There are currently no downstream dependencies for this package.
更時含:
得:cran-comments.md 準總諸臺察果與釋諸注。
敗:察果跨臺異→文諸異。CRAN 審將比此於己測。
# One last check
devtools::check()
# Verify the built tarball
devtools::build()
得:末 devtools::check() 清過。.tar.gz 構於父目。
敗:末刻問現→正之、自步二再行諸察。勿以知敗投。
devtools::release()
此行交互察而投。誠答諸問。
或於 https://cran.r-project.org/submit.html 手投上傳 tarball。
得:CRAN 確郵分內至。點確接以定投。
敗:察郵拒因。常因:例過緩、缺 \value 標、不可移碼。正而再投、於 cran-comments.md 記何改。
受後:
# Tag the release
usethis::use_github_release()
# Bump to development version
usethis::use_dev_version()
得:GitHub 發以受版標建。DESCRIPTION 升至開發版(x.y.z.9000)。
敗:GitHub 發敗→以 gh release create 手建。CRAN 受延→待確郵乃標。
R CMD check 本地返 0 誤 0 警cran-comments.md 準述察果\donttest{}。CRAN 強時限.Rbuildignore)\value:諸出函需 @return 標.Renvironrevdepcheck::revdep_check()# Full pre-submission workflow
devtools::spell_check()
urlchecker::url_check()
devtools::check()
devtools::check_win_devel()
rhub::rhub_check()
# Wait for results...
devtools::release()
release-package-version - 版升與 git 標write-roxygen-docs - 確文合 CRAN 標setup-github-actions-ci - CI 察反 CRAN 期build-pkgdown-site - 受包文站