The goal of hubCI is to provide functionality for setting up hubverse Continuous Integration workflows.
You can install the latest version of hubCI from the R-universe:
install.packages("hubCI", repos = c("https://hubverse-org.r-universe.dev", "https://cloud.r-project.org"))If you want to test out new features that have not yet been released, you can install the development version of hubCI from GitHub with:
# install.packages("remotes")
remotes::install_github("hubverse-org/hubCI")For hubs hosted on GitHub, use use_hub_github_action() to download one
of the hubverse GitHub
Actions.
Note: the hub most be configured as an R project (i.e. contain a
*.Rproj file)
library(hubCI)
use_hub_github_action(name = "validate-submission")The workflows depend on other GitHub Actions, both third-party actions
such as actions/checkout and the hubverse actions themselves. An
action referenced by major version picks up minor and patch releases
automatically, but a new major release does not reach the hub until the
workflow is edited.
use_hub_dependabot() installs a configuration file at
.github/dependabot.yml. This file configures
Dependabot,
GitHub’s dependency update service, to check the actions the hub’s
workflows depend on once a week. For each action with a new major
version, Dependabot opens a pull request in the hub that updates the
workflow to it. This keeps the hub’s workflow dependencies current, with
each update reviewed rather than discovered when an old version stops
working.
use_hub_dependabot()Please note that the hubCI package is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
Interested in contributing back to the open-source Hubverse project? Learn more about how to get involved in the Hubverse Community or how to contribute to the hubCI package.