Fix: Added Github Actions to check for broken embedded links. #1970
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SoumyaMukhija
requested review from
maribethb
and removed request for
a team
|
@maribethb were you still planning on taking a look at this? I don't think I have the expertise to review. |
|
Yes, I'm so sorry for the long delay. This has also required me to learn some new things and set up local testing. |
Hi @maribethb , did you get a chance to look into this? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The basics
The details
Fixes #697
The
broken-link-check.ymlchecks for bad links embedded in markdown files throughout the repository. If it fails (ie, one or more links are not working) then thebroken-link-issue.ymlis triggered. This creates an issue with the error info generated by the first workflow.Since the output of
broken-link-checkcannot be retrieved before the entire workflow is complete, the 2 tasks had to be divided into 2 separate workflows (instead of jobs or steps).The issue is created using the
ISSUE_TEMPLATEfile and lists, in JSON-style format, all the details provided by the first workflow. This template can be modified to include assignees, etc.These workflows will be triggered every time someone pushes to main and every Thursday at 8 AM PST.
Proposed Changes
Introduced 2 separate workflows to solve the issue.
Reason for Changes
The workflows are triggered on 2 occasions and create an issue in case of broken links. I believe this would be a more convenient solution than Node scripts.
Test Coverage
N/A.
Documentation
N/A.
Additional Information
It is important to note that by design, the plugins used in both of these workflow files are only known to work on the main branch of the repository.