Skip to content

Scheduled Link Checks of OSCAL Repo's Main Branch and Automatically Open Issues for Broken Links #1230

@aj-stein-nist

Description

@aj-stein-nist

User Story:

As an OSCAL tool developer, in order to know all internal and external hyperlinks are valid over time and not only when specific developers make modifications that are sometimes not related to modified links, I want the OSCAL's CI/CD automation to periodically examine links for the OSCAL website and repo Markdown documentation for broken links on a schedule. If a broken link is found, I would like a new issue to be automatically opened indicating which link should be subsequently handled by an available developer.

Goals:

Improve the OSCAL CI/CD system so that broken links can be detected outside of a developer code/test/push cycle, which often might not be related to doc and website improvement.

Dependencies:

Complete after #1208 is complete.

Acceptance Criteria

  • Add a GitHub Actions workflow to schedule a cron job for the markdown-link-check action for Markdown docs outside the website content.
  • Add a GitHub Actions workflow to schedule a cron job for the lychee-action action for OSCAL website content link checks.
  • All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.

Metadata

Metadata

Assignees

Labels

Developer ExperienceIssues around enhancing and optimizing work for development of NIST OSCAL artifactsScope: CI/CDEnhancements to the project's Continuous Integration and Continuous Delivery pipeline.Scope: WebsiteIssues targeted at the OSCAL project website.User Storyenhancement

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions