Package 'hubCI'

Title: Toolbox for hubverse Continuous Integration
Description: Functions for setting up hubverse Continuous Integration workflows.
Authors: Anna Krystalli [aut, cre] , Nicholas G. Reich [ctb] , Evan L. Ray [ctb], Consortium of Infectious Disease Modeling Hubs [cph]
Maintainer: Anna Krystalli <[email protected]>
License: MIT + file LICENSE
Version: 0.0.1
Built: 2024-10-31 04:35:07 UTC
Source: https://github.com/hubverse-org/hubCI

Help Index

Hubverse GitHub Action setup

Description

Sets up common continuous integration (CI) workflows for a hub that is hosted on GitHub using GitHub Actions. Available actions are hosted in repository hubverse-org/hubverse-actions The function creates the necessary directories and downloads the requested GitHub Action yaml file.

Usage

use_hub_github_action(name, ref = NULL)

Arguments

name

Name of workflow, i.e. the name of one of the action repository directories containing a GitHub Action workflow .yaml file.
ref

Desired Git reference, usually the name of a tag ("v0.1.0") or branch ("main"). Other possibilities include a commit SHA ("d1c516d") or "HEAD" (meaning "tip of remote's default branch"). If not specified, defaults to the latest published release of hubverse-org/hubverse-actions (https://github.com/hubverse-org/hubverse-actions/releases)

Examples

## Not run: 
use_hub_github_action(name = "validate-submission")

## End(Not run)