Skip to contents

Readme Render

Source: vignettes/readme-render.Rmd
readme-render.Rmd

Render README Workflow

This GitHub Actions workflow renders the README from R Markdown (README.Rmd) to Markdown (README.md). Additionally, it can format the generated Markdown using a formatter. The workflow is triggered manually (workflow_dispatch) and can also be invoked as a workflow call (workflow_call).

Workflow Structure

The workflow consists of a single job: render.

render Job

This job renders the README from R Markdown to Markdown and optionally formats the generated Markdown.

Inputs
  • r-version: The version of R to use. Default is ‘release’.
  • skip-md-formatting: Skip markdown auto-formatting. Default is ‘false’.
Steps
  1. Get branch names: Extracts branch names.
  2. Checkout repo (PR): Checks out the repository based on the event type (pull request).
  3. Checkout repository: Checks out the repository for events other than pull requests.
  4. Normalize inputs: Normalizes the R version input.
  5. Restore cache: Restores cached dependencies.
  6. Run Staged dependencies: Runs staged dependencies action.
  7. Install dependencies from DESCRIPTION: install dependencies from DESCRIPTION (in case of missing dependencies in parent admiralci docker image)
  8. Render README to markdown: Renders README.Rmd to README.md.
  9. Install Markdown formatter: Installs the Markdown formatter if not skipping formatting.
  10. Commit and push formatted README.md: Commits and pushes changes to the formatted README.md file.

Triggers

  • workflow_dispatch: Manually triggered workflow with optional inputs.
  • workflow_call: Invoked as a workflow call.

Permissions

  • contents: write: Write permissions for repository contents.