Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
briefcase

GitHub Action

ottr-reports

v0.3

ottr-reports

briefcase

ottr-reports

Run OTTR checks for spelling, urls, and quiz formats

Installation

Copy and paste the following snippet into your .yml file.

              

- name: ottr-reports

uses: jhudsl/ottr-reports@v0.3

Learn more about this action in jhudsl/ottr-reports

Choose a version

OTTR Reports

This action runs either spelling, url, or quiz format checks in an OTTR course.

Inputs

check_type

Required the type of check to be done. Either spelling, urls, or quiz_format.

error_min

What number of errors should make this check fail? Default is 0.

Outputs

A report called one of the following: 'resources/spell_check_results.tsv', 'resources/url_checks.csv', or 'resources/question_error_report.tsv',

It also will print out the report as a GitHub comment on a pull request.

Example usage

For spelling checks:

uses: jhudsl/OTTR_Reports/report-maker
with:
  check_type: "spelling"
  error_min: 3

For broken url checks:

uses: jhudsl/OTTR_Reports/report-maker
with:
  check_type: "urls"
  error_min: 0

For quiz_format checks:

uses: jhudsl/OTTR_Reports/report-maker
with:
  check_type: "quiz_format"
  error_min: 0