From ace454cbf8b1fb6a685989e77de351e8ab51bc81 Mon Sep 17 00:00:00 2001 From: Candace Savonen Date: Tue, 25 Jun 2024 20:36:18 -0400 Subject: [PATCH] Update customize-robots.Rmd --- customize-robots.Rmd | 33 +++++++++++++++++++++++++++------ 1 file changed, 27 insertions(+), 6 deletions(-) diff --git a/customize-robots.Rmd b/customize-robots.Rmd index 304f497..e84efd6 100644 --- a/customize-robots.Rmd +++ b/customize-robots.Rmd @@ -11,18 +11,29 @@ By default, all automation steps and checks will run. Based on the requirements The `config_automation.yml` file looks like this: ``` -# Formatting Checks (run at pull request) -check-quizzes: yes +##### Checks run at pull request ##### +# Check quiz formatting +check-quizzes: no +# Check that urls in the content are not broken url-checker: yes +# Render preview of content with changes (Rmd's and md's are checked) render-preview: yes -style-and-sp-check: yes +# Spell check Rmds and quizzes +spell-check: yes +# Style any R code +style-code: yes +# Test build the docker image if any docker-relevant files have been changed +docker-test: no +# Should URLs be tested periodically? +url-check-periodically: yes ... ``` -There are two main sets of automation steps and checks run: +There are three main sets of automation steps and checks run: - `.github/workflows/pull-request.yml` : Run upon opening a pull request - `.github/workflows/render-all.yml`: Run upon any changes merged to the `main` branch +- `.github/workflows/check-url.yml`: Run checks of URLs in a OTTR repo periodically to see if any are no longer valid ## Pull Request Checks: @@ -41,7 +52,9 @@ Leanpub needs a particular format for it to upload correctly. This action will l ### Check for broken URLs -In the `config_automation.yml` file it is set by: +In the `config_automation.yml` file there are two different URL checkers. + +1) One that is run during pull requests. It is set by: ``` url-checker: yes ``` @@ -49,7 +62,15 @@ url-checker: yes GitHub Actions runs a check on all the URLs upon creating a pull request to the `main` branch. If it fails, you can click on the output comment on your pull request that says "Download errors here". This will give you a print out of the broken URLs it found. -If the URL checker is failing on something that isn't really a URL or doesn't need to be checked, open the `resources/ignore-urls.txt` file and add that URL exactly as it is specified in the error print out. +GitHub Actions runs a check on all the URLs upon creating a pull request to the `main` branch. +If it fails, you can click on the output comment on your pull request that says "Download errors here". This will give you a print out of the broken URLs it found. + +2) The other URL check runs on a set interval to see if any URLs referenced are no longer valid. This one is set by: +``` +url-check-periodically: yes +``` + +If either URL checker is failing on something that isn't really a URL or doesn't need to be checked, open the `resources/ignore-urls.txt` file and add that URL exactly as it is specified in the error print out. ### Preview rendering