diff --git a/_bookdown.yml b/_bookdown.yml index b7ecbf4..8ebf7cb 100644 --- a/_bookdown.yml +++ b/_bookdown.yml @@ -26,6 +26,7 @@ rmd_files: ["index.Rmd", "ai-policy-third-party.Rmd", "non-software-packages.Rmd", "gitignore-file.Rmd", + "build-check-bioccheck.Rmd", "devguide-conclusion.Rmd", "package-maintainence.Rmd", "git-version-control.Rmd", diff --git a/build-check-bioccheck.Rmd b/build-check-bioccheck.Rmd new file mode 100644 index 0000000..300ddb2 --- /dev/null +++ b/build-check-bioccheck.Rmd @@ -0,0 +1,22 @@ +# Build / Check / BiocCheck + +All new packages submitted are checked against the current Bioconductor devel +version. Bioconductor versions are closely associated with a specific R version. The +submitter should ensure the package is built and checked against the appropriate +version. + + +The package should `R CMD build`, `R CMD check`, and `BiocCheck` without ERROR. +See useful tools like [devools][] and [BiocCheck][] for more information. + + +As Bioconductor moves towards integration with +[R-universe][], it is also possible to set up a +GitHub Action to mimic the submission process environment. You will need to +ensure your [repository +settings](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository) +have GitHub actions enabled. The process for setting up the workflow to run +build, check and BiocCheck in github actions is documented on the R-Universe help page section for [Bioconductor and R-universe](https://docs.r-universe.dev/bioconductor/#debugging-the-ci) + + + diff --git a/index.Rmd b/index.Rmd index ce5e045..117b858 100644 --- a/index.Rmd +++ b/index.Rmd @@ -181,3 +181,7 @@ knitr::write_bib(c( [testy]: https://github.com/ahoward/testy [Valgrind]: http://valgrind.org/ [Xcode]: https://developer.apple.com/xcode/ + +[devools]: https://devtools.r-lib.org/reference/check.html +[BiocCheck]: https://www.bioconductor.org/packages/BiocCheck/ +[R-Universe]: https://r-universe.dev/search \ No newline at end of file