Draft: Github Action: Continuous integration to check link validity. #12
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.
Background
The wiki is a valuable tool for centralizing information, but it faces a unique challenge that can impact the user experience - Broken external links.
While the links are valid at the time of the wiki commit, their state can become broken in the coming months due to factors outside of our control. This issue is compounded by the large number of links present in the wiki, making it difficult to proactively monitor and maintain them all.
Addressing this challenge is crucial for preserving the integrity and usability of the wiki. By treating external links as a managed state, we can ensure a reliable and consistent user experience, even as the broader web landscape evolves.
This pull request aims to introduce a solution that will help us better control and maintain the state of external links within the wiki, enhancing its long-term viability and value to our users.
Change description
Leverage Github action to have continuous integration flow in order to check all the links while a new pull request or a commit on the main branch is performed.
After running the Github action on my personal fork I was able to spot a total of 29 links that was broken... So of them are also false positive.
screenshot:
See full detail: https://github.com/olivierodo/creatorsgarten-wiki/actions/runs/10676565324
I'm the main maintainer of the Github action used: https://github.com/atalent-labs/404-links feel free to raise your concerns 🙏
Type of change
Related issues
N/A
Checklists
Development
Security
Code review