Skip to content

Link Check Report Procedure

Jump to bottom
Arminta Jenkins edited this page Jun 5, 2023 · 5 revisions

Background

The link-check.yml workflow is used to check links in markdown documents.

What triggers link checking?

The link checking is triggered by a cronjob scheduled GitHub Action workflow. The job runs every day at 0800 UTC (0400 EST).

Checklist

  1. Search the usnistgov/OSCAL repo for "Scheduled Check of Markdown Documents..."
  2. Check the github-action comment for the results:
  • links with a ✓ indicate that no issue was found
  • links with a ✖ indicate an error occurred ,
  • links with a / indicate ???
  1. Check for false positives by clicking the links with errors

NOTE: This information exists for the benefit of NIST staff. Although the community may reference or inquire about content, this material is not explicitly intended for community support. The community may create issues to report bugs or request enhancements related to this documentation, but there is no support guarantees for this material. All issues will be considered on a case by case basis.

Standard Operating Procedures

Developer Knowledge Base

Team Members' Responsibilities

Clone this wiki locally