GITHUB.md

GitHub Folder

Contents

• Overview
• GitHub Action Workflows
  • Status Badges

Overview

The folder houses GitHub-specific files, specifically:

• GitHub Labels Configuration YAML file: labels.yml
• GitHub Dependabot Configuration YAML file: dependabot.yml
• Suite of GitHub Action Workflows in the .github/workflows/ folder.

GitHub Action Workflows

Currently, this package employs the following suite of GitHub Actions in its CI/CD DevOps pipelines:

• check.yml: Performs a cross-platform package check (via R CMD CHECK) on every push and pull request into main.
• coverage.yml: Tests and runs code-coverage analysis (via covr::codecov()) on the package.
• docker.yml: Builds package's Dockerfile's for database(s) and APIs and pushes them to this repo's GitHub Container Registry or ghcr.io. See actuarialdb for an example.
• document.yml: Roxygenize's the R Package by running roxygen2::roxygenize() (akin to devtools::document()).
• gh-release.yml: Performs actions for a GitHub Release.
• gha-versions.yml: Updates the GitHub Actions versions themselves.
• git-cliff.yml: Updates the CHANGELOG.md via git-cliff.
• labels.yml: Applies repo-specific GitHub Issue Labels
• linguist.yml: Applies .gitattributes for GitHub-Linguist.
• lint-changes.yml: Only applies to pull-requests - lints code changes.
• lintr.yml: Lints the R Package codebase.
• pkgdown.yml: Creates and deploys the package documentation site via pkgdown.
• style.yml: Implements styleR on the R package.
• toc.yml: Updates the README.md's table of contents.

Status Badges

• 
• 
•