Skip to content

Commit

Permalink
Update customize-robots.Rmd
Browse files Browse the repository at this point in the history
  • Loading branch information
cansavvy authored Jun 26, 2024
1 parent 4166d7f commit ace454c
Showing 1 changed file with 27 additions and 6 deletions.
33 changes: 27 additions & 6 deletions customize-robots.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -41,15 +52,25 @@ 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
```

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

Expand Down

0 comments on commit ace454c

Please sign in to comment.