blockly-samples
blockly-samples copied to clipboard
google
Fix: Added Github Actions to check for broken embedded links.
The basics
- [x] I validated my changes
The details
Fixes #697
The broken-link-check.yml checks for bad links embedded in markdown files throughout the repository. If it fails (ie, one or more links are not working) then the broken-link-issue.yml is triggered. This creates an issue with the error info generated by the first workflow.
Since the output of broken-link-check cannot 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_TEMPLATE file 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.
@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.
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?
Hi @SoumyaMukhija I'm so sorry for the long delay on this. I'm merging it into a separate branch so I can poke it a bit before merging it to master. Thank you for your work on this issue!