|
2 | 2 |
|
3 | 3 | This directory contains workflows to be used for Lessons using the {sandpaper}
|
4 | 4 | lesson infrastructure. Two of these workflows require R (`sandpaper-main.yaml`
|
5 |
| -and `pr-recieve.yaml`) and the rest are bots to handle pull request management. |
| 5 | +and `pr-receive.yaml`) and the rest are bots to handle pull request management. |
6 | 6 |
|
7 | 7 | These workflows will likely change as {sandpaper} evolves, so it is important to
|
8 | 8 | keep them up-to-date. To do this in your lesson you can do the following in your
|
@@ -94,9 +94,9 @@ branch called `update/workflows` and a pull request is created. Maintainers are
|
94 | 94 | encouraged to review the changes and accept the pull request if the outputs
|
95 | 95 | are okay.
|
96 | 96 |
|
97 |
| -This update is run ~~weekly or~~ on demand. |
| 97 | +This update is run weekly or on demand. |
98 | 98 |
|
99 |
| -### 03 Maintain: Update Pacakge Cache (update-cache.yaml) |
| 99 | +### 03 Maintain: Update Package Cache (update-cache.yaml) |
100 | 100 |
|
101 | 101 | For lessons that have generated content, we use {renv} to ensure that the output
|
102 | 102 | is stable. This is controlled by a single lockfile which documents the packages
|
@@ -140,7 +140,7 @@ Once the checks are finished, a comment is issued to the pull request, which
|
140 | 140 | will allow maintainers to determine if it is safe to run the
|
141 | 141 | "Receive Pull Request" workflow from new contributors.
|
142 | 142 |
|
143 |
| -### Recieve Pull Request (pr-recieve.yaml) |
| 143 | +### Receive Pull Request (pr-receive.yaml) |
144 | 144 |
|
145 | 145 | **Note of caution:** This workflow runs arbitrary code by anyone who creates a
|
146 | 146 | pull request. GitHub has safeguarded the token used in this workflow to have no
|
@@ -171,7 +171,7 @@ The artifacts produced are used by the next workflow.
|
171 | 171 |
|
172 | 172 | ### Comment on Pull Request (pr-comment.yaml)
|
173 | 173 |
|
174 |
| -This workflow is triggered if the `pr-recieve.yaml` workflow is successful. |
| 174 | +This workflow is triggered if the `pr-receive.yaml` workflow is successful. |
175 | 175 | The steps in this workflow are:
|
176 | 176 |
|
177 | 177 | 1. Test if the workflow is valid and comment the validity of the workflow to the
|
|
0 commit comments