Git Actions

We have set up several checks for website content edits.

When you create a pull request, you will see something like this if everything is successful. You can click on the preview of website here link to see a preview. Please note that some features may not be possible to see in the preview. For example, icons may only show up as a box.

Rendering Action

If the rendering action fails, you will see something like this:

If you click on where it says Details on the far right, you will be taken to more information about what may have gone wrong.

For example, we can see that an R object was not found in one of the files. You could identify which file by scrolling up.

Spelling and Style Action

You may find that you have spelling errors if you get the following message from your pull request (PR):

If this happens, click the Download the errors here. link. This will take you to a table with words that the check thought were misspelled, as well as what file they occurred in and the lines in that file.

Add words that are not actually misspelled to the dictionary.txt file located in the resources directory. It’s a good idea to try to keep this in alphabetical order.

For words that are indeed misspelled, fix the errors and push your changes to your pull request.

You should then see that your pull request has a different message that tells you that you have no spelling errors.

URL Check

You may find that you have broken URLs. If so, you will get this message when you create a Pull Request.

You can click on the Download the errors here link to see a document with a list of broken URLs and what files they are located in, like this:

Here we can see that there are two URLs that are broken in the git_actions.Rmd file.

Completing a Pull Request

Once all the Git Action checks pass, you can merge your pull request to your main branch for your website.

If you are only working on this yourself without others to review your pull request, you can click the Merge without waiting for requirements to be met box, so that you can click the Merge pull request button.