Continuous integration with GitHub actions
Open
Nobody has claimed this yet.
ci/cd
github
- Dominant language
- No language data
- Stars
- 17
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
This new GitHub feature may simplify continuous integration, and there is an R package to help you do that: https://r-lib.github.io/ghactions/
For example, for the development of an R package:
- Add the secret
GH_PATto GitHub settings. - create a file in .github/workflows/main.yml that looks something like this:
'on':
- push
- pull_request
jobs:
build:
runs-on: ubuntu-18.04
container:
image: rstudio/r-base:3.6-xenial
steps:
- name: Checkout Repository
uses: actions/checkout@master
- name: Install System Dependencies
run: |
sudo apt-get update && apt-get install -y --no-install-recommends \
docker \
git \
libxml2-dev \
libssl-dev \
&& apt-get clean -y \
&& curl -fsSL https://get.docker.com -o get-docker.sh \
&& sh get-docker.sh
- name: Install package dependencies
run: |
Rscript -e "install.packages(c('pkgdown', 'remotes', 'rcmdcheck'), repos = 'https://demo.rstudiopm.com/all/__linux__/bionic/latest')"
Rscript -e "remotes::install_deps(dependencies = TRUE)"
- name: Check package
run: |
Rscript -e "rcmdcheck::rcmdcheck(error_on = 'error', check_dir = 'check')"
- name: Document Package
run: |
Rscript -e "pkgdown::build_site(examples = FALSE)"
- name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/master'
uses: maxheld83/ghpages@v0.2.0
env:
BUILD_DIR: docs
GH_PAT: ${{ secrets.GH_PAT }}
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the proposed .github/workflows/main.yml and review the listed R package checks, pkgdown build, and GitHub Pages deployment steps. Done would be a repository-appropriate GitHub Actions workflow that runs the intended checks and deployment successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, github-actions, r
- Domain
- ci-cd, devops
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100