https://github.com/ijlyttle/projthis-demo
Demo of projthis
https://github.com/ijlyttle/projthis-demo
Last synced: about 2 months ago
JSON representation
Demo of projthis
- Host: GitHub
- URL: https://github.com/ijlyttle/projthis-demo
- Owner: ijlyttle
- License: other
- Created: 2020-10-25T21:23:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-15T08:05:42.000Z (2 months ago)
- Last Synced: 2025-02-15T11:48:12.295Z (2 months ago)
- Size: 679 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - ijlyttle/projthis-demo - Demo of projthis (Others)
README
---
output: github_document
title: "projthis Demonstration"
date: '`r lubridate::now(tz = "UTC")` UTC'
---The goal of this project is to show how you can use the [projthis]() package, along with [usethis](), to build a project workflow that manages package dependencies.
## Demo
This demo is run automatically by GitHub Actions, every day at 02:30 UTC, as well as whenever there is a change to `README.Rmd`.
For this demo, we will select a letter at random, then get a data frame of the top ten most-downloaded packages (from the day's top 100) that contain this letter in its name.
```{r setup, message=FALSE}
library("cranlogs")
library("dplyr")
library("stringr")
library("conflicted")conflict_prefer("filter", "dplyr")
``````{r letter}
letter <- sample(letters, 1)
letter
``````{r}
cran_top_downloads(when = "last-day", count = 100) %>%
filter(str_detect(package, regex(letter, ignore_case = TRUE))) %>%
head(10)
```## Steps
These are the steps I took to build this project and automate the GitHub Actions workflow.
```r
library("projthis")
library("usethis")
```### Initial structure
1. `proj_create("../projthis-demo")`
1. `use_mit_license()`
1. `use_git()`
1. `use_github()`
1. `use_readme_rmd()`
1. edit `README.Rmd` and `DESCRIPTION`## Create demo
1. Add **Demo** section to `README.Rmd`
1. `proj_update_deps()` to add packages to `DESCRIPTION`## Add GitHub Action
We want to automate the build on a schedule.
1. `proj_use_github_action()`
1. Modify `.github/workflows/project-run.yaml` to customize trigger, what is built, and what is deployed.This is a modification of the [pkgdown Actions file](https://github.com/r-lib/actions/blob/v2/examples/pkgdown.yaml), where the build is triggered by either:
- a change to `README.Rmd`
- the clock changing to 08:00 UTC```yaml
on:# # runs whenever you push a specific branch
# push:
# branches: [main, master]# # runs on pull requests to a specific branch
# pull_request:
# branches: [main, master]
# runs when we push README.Rmd
push:
paths:
- README.Rmd# runs on a schedule using UTC - see https://en.wikipedia.org/wiki/Cron
schedule:
- cron: '00 02 * * *' # 08:00 UTC, every day
```I also modified a bit at the end of the Actions file, to specify the rendering and deployment. In this case, we are rendering the `README.Rmd` file, committing `README.md` then pushing back to the original branch:
```yaml
# rename and adapt this step to build your project
- name: Render
# if you are running only R commands, this can be a convenient syntax
run: |
rmarkdown::render("README.Rmd")
shell: Rscript {0}# rename and adapt this step to deploy your project
- name: Commit
# if you need to combine R commands with shell commands, try this syntax
#
# caution to stay away from syntax like `git add -A` as you might be committing
# files that you would prefer not to commit:
# https://twitter.com/JennyBryan/status/1319320033063923712
run: |
git config --local user.email "actions@github.com"
git config --local user.name "GitHub Actions"
git add "README.md"
git commit -m 'automated run' || echo "No changes to commit"
git push origin || echo "No changes to commit"
```It is likely your build and deploy processes will be more complicated, but this gives you a sense of how to get things working.
In Actions, as with any CI system, there is an element of "try stuff until it works", which can be frustrating.