Create nightly Github workflow to check for dead links #836
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.
Description
This creates a Github workflow that runs nightly at 1PM. In this workflow, there is a job that runs a program called lychee that scans all the code in the html, js and markdown files in the
src
,test,
scripts
and base directories foradobe.ly
andexperienceleague.adobe.com
links. It then makes a small request to each of these links to see if they are still alive.Essentially, it runs the following command
If there are any dead links (4xx or 5xx response codes), it will run the next job in the workflow, which
uses theuses the craftech-io/slack-action library to post a message in the #alloy-ci Slack channel so that we may resolve them.create-issue-from-file
library to create a Github Issue that lists the linksI chose to only look for
adobe.ly
links andexperienceleague.adobe.com
links to avoid the many Adobe internal, license, and example links that we have within our code.I expect that the check will run in under 60 seconds.
Related Issue
PDCL-7744:
Motivation and Context
This will prevent customers stumbling across links that no longer point to the desired location, as happened in #808.
Screenshots (if appropriate):
Types of changes
Checklist: