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.8

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/[email protected]
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.

gh_pat

You must pass a Github Secret that has repository privileges that this action can use.

Outputs

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

Example usage

For spelling checks:

uses: jhudsl/ottr-reports/.github/workflows/report-maker.yml@main
with:
  check_type: spelling
  error_min: 3
  gh_pat: secrets.GH_PAT

For broken url checks:

uses: jhudsl/ottr-reports/.github/workflows/report-maker.yml@main
with:
  check_type: urls
  error_min: 0
  gh_pat: secrets.GH_PAT

For quiz_format checks:

uses: jhudsl/ottr-reports/.github/workflows/report-maker.yml@main
with:
  check_type: quiz_format
  error_min: 0
  gh_pat: secrets.GH_PAT