Adding a config_automation.yml

.github/sync.yml

@@ -70,3 +70,25 @@ group:
       dest: scripts/spell-check.R
     repos: |
       jhudsl/OTTR_Template_Website
+
+  repos: |
+    jhudsl/OTTR_Template_Website
+  - source: .github/workflows/style-and-sp-check.yml
+    dest: .github/workflows/style-and-sp-check.yml
+  - source: .github/workflows/url-checker.yml
+    dest: .github/workflows/url-checker.yml
+  - source: scripts/spell-check.R
+    dest: scripts/spell-check.R
+###### TO ADD NEW REPOSITORY USE THIS FORMAT; Feel free to add/drop files that
+# you specifically would like synced (or not).
+#
+#  # Repositories to receive changes
+#  repos: |
+#    org/repo_name
+#  # Files which should be updated
+#  - source: .github/workflows/
+  #   dest: .github/workflows/
+  # - source: scripts/
+  #   dest: scripts/
+  # - source: docker/
+  #   dest: docker/

.github/workflows/manage-gha.yml

@@ -0,0 +1,34 @@
+# Candace Savonen Feb 2022
+
+name: Update Github Actions Switches
+
+on:
+  push:
+    paths:
+      - 'config_automation.yml'
+
+jobs:
+  update-triggers:
+    runs-on: ubuntu-latest
+    container:
+      image: jhudsl/course_template
+
+    steps:
+      - name: checkout repo
+        uses: actions/checkout@v2
+
+      - name: Login as jhudsl-robot
+        run: |
+          git config --local user.email "itcrtrainingnetwork@gmail.com"
+          git config --local user.name "jhudsl-robot"
+
+      - name: Run GHA switches script
+        run: Rscript --vanilla scripts/employ-gha-switches.R
+
+      - name: Commit updated workflows to current branch
+        id: commit_it
+        run: |
+          branch_name=$(git rev-parse --abbrev-ref HEAD)
+          git add .github/workflows --force
+          git commit -m 'Update GHA switches' || echo "No changes to commit"
+          git push origin || echo "No changes to commit"

config_automation.yml

@@ -0,0 +1,13 @@
+# PR Checks
+check-quizzes: yes
+url-checker: yes
+render-preview: yes
+style-and-sp-check: yes
+
+# Rendering
+render-bookdown: yes
+render-leanpub: yes
+render-coursera: yes
+
+# Docker specific
+docker-build-test: yes

scripts/employ-gha-switches.R

@@ -0,0 +1,77 @@
+#!/usr/bin/env Rscript
+
+library(magrittr)
+
+# Make extract trigger function
+extract_trigger <- function(gha_contents) {
+  # Extract trigger criteria
+  trigger_start <- grep("TRIGGER-START", gha_contents)
+  trigger_end <- grep("TRIGGER-END", gha_contents)
+
+  return(trigger_start:trigger_end)
+}
+
+# Find .git root directory
+root_dir <- rprojroot::find_root(rprojroot::has_dir(".github"))
+
+### Load in "on" triggers
+
+# Each github action has its own
+on_triggers <- readr::read_rds(file.path(root_dir, ".github", "on-triggers.rds"))
+
+# Same off trigger for all
+off_trigger <- c("#---TRIGGER-START---#",
+                 "on:",
+                 "  workflow_dispatch:",
+                 "#---TRIGGER-END----#")
+
+### Read in and set up config automation yaml
+
+# Get github actions directory
+github_actions_dir <- file.path(root_dir, ".github", "workflows")
+
+# Get list of github actions files
+github_actions_files <- list.files(github_actions_dir, pattern = "\\.yml$",
+                                   full.names = TRUE)
+
+# Set up the list of the gha
+config_yaml <- yaml::read_yaml(file.path(root_dir, "config_automation.yml")) %>%
+  data.frame() %>%
+  t() %>%
+  data.frame() %>%
+  tibble::rownames_to_column("gha_files") %>%
+  dplyr::mutate(gha_files = paste0(gsub("\\.", "-", gha_files), ".yml"))
+
+colnames(config_yaml)[2] <- "on_or_off"
+
+# Read in all files
+all_gha <- lapply(github_actions_files, function(gha_file) {
+
+  # Read in yaml
+  yaml_contents <- readLines(gha_file)
+
+  # Should this be on or off?
+  status <- config_yaml %>%
+    dplyr::filter(basename(gha_file) == gha_files) %>%
+    dplyr::pull("on_or_off")
+
+  if (length(status) == 1) {
+    message(paste("Turning trigger on:", status, "for", basename(gha_file)))
+    # Get trigger indices
+    trigger_indices <- extract_trigger(yaml_contents)
+
+    if (status) {
+      trigger <- on_triggers[[basename(gha_file)]]
+    } else {
+     trigger <- off_trigger
+   }
+
+  # Remove current trigger
+  yaml_contents <- yaml_contents[-trigger_indices]
+
+  # Put new trigger in
+  yaml_contents <- append(yaml_contents, trigger, after = trigger_indices[1] - 1)
+
+  writeLines(yaml_contents, gha_file)
+  }
+})

scripts/store-triggers.R

@@ -0,0 +1,32 @@
+# Write on-trigger yaml
+# This script stores what the 'on' triggers look like for each github action
+
+# Find .git root directory
+root_dir <- rprojroot::find_root(rprojroot::has_dir(".github"))
+
+# Get github actions directory
+github_actions_dir <- file.path(root_dir, ".github", "workflows")
+
+# Get list of github actions files
+github_actions_files <- list.files(github_actions_dir, pattern = "\\.yml$", 
+                                   full.names = TRUE)
+
+# Don't manage the manager
+github_actions_files <- grep("manage-gha.yml", github_actions_files, value = TRUE, invert = TRUE)
+
+# Read in all files
+all_gha <- lapply(github_actions_files, readLines)
+names(all_gha) <- basename(github_actions_files)
+
+# Make extract trigger function
+extract_trigger <- function(gha_contents) {
+  # Extract trigger criteria
+  trigger_start <- grep("TRIGGER-START", gha_contents)
+  trigger_end <- grep("TRIGGER-END", gha_contents)
+
+  return(gha_contents[trigger_start:trigger_end])
+}
+
+on_triggers <- lapply(all_gha, extract_trigger)
+
+readr::write_rds(on_triggers, file.path(root_dir, ".github", "on-triggers.rds"))