setup_github_actions {altdoc}

Create a Github Actions workflow

Description

This function creates a Github Actions workflow in ".github/workflows/altdoc.yaml". This workflow will automatically render the website using the setup specified in the folder "altdoc" and will push the output to the branch "gh-pages".

Usage

setup_github_actions(path = ".")

Arguments

path

Path to the package root directory.

Value

No value returned. Creates the file ".github/workflows/altdoc.yaml"

Examples

if (interactive()) {
  setup_github_actions()
}