URL check - jhudsl/OTTR_Template GitHub Wiki

Table of Contents generated with DocToc

• Running locally
• Ignoring URLs

Github actions will automatically run a url check on all Rmds and mds whenever a pull request to the main branch is filed. See this section about how to customize what checks are run. Depending on your preference, you may find it easier to url check manually on your local computer before pushing to Github.

It will fail if there are any broken urls and you'll need to resolve those before being able to merge your pull request.

Click on the GitHub comment that has the download link to url errors that need to be resolved.

Some of these errors may be things that aren't actually a url. If so, then add these to the resources/ignore-urls.txt file. Add the fake url exactly as it is reported in the check_reports/url_checks.tsv file that is linked in the comment. Then commit your adds to resources/ignore-urls.txt to your working branch and this should make the url check status check pass.

Running locally

You can run url check locally by calling the script from the top of the repository (your main git repository directory) in bash:

Rscript scripts/url-check.R

The report will be saved to check_reports/url_checks.tsv