Skip to content

[FEATURE] Create a GitHub Workflow or Automated Process to Check and Report on Broken Links in the README #63

@crugas

Description

@crugas

Description:

Create a GitHub workflow or automated process to check for any broken links contained in the README.md file and generate a report of said broken links for remediation. We would need the process to:

  • Find all URLs in the README.md file for this GitHub repo
  • Test that the URLs return 200 status code
  • IF a URL returns a redirect, only allow X number of redirects before defaulting to a broken link
  • Note any URLs that return anything other than 200 status code (including failed redirects)
  • Generate a report (excel file, log, csv) listing:
    • The broken link
    • The error code
    • Optional: where in the README.md the broken link is found (line number)
  • Store generated report somewhere - in this repo is most direct place

Additional_Context:
#59

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions