Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft: Github Action: Continuous integration to check link validity. #12

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

olivierodo
Copy link

@olivierodo olivierodo commented Sep 3, 2024

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:

image

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

  • Bug fix (fixes an issue)
  • New feature (adds functionality)

Related issues

N/A

Checklists

Development

  • Lint rules pass locally
  • Application changes have been tested thoroughly
  • Automated tests covering modified code pass

Security

  • Security impact of change has been considered
  • Code follows project security practices and guidelines

Code review

  • Pull request has a descriptive title and context useful to a reviewer. Screenshots or screencasts are attached as necessary
  • Changes have been reviewed by at least one other contributor
  • Pull request linked to issue tracker where applicable

Propose to add a link linter in order to check validity of the link provided in the wiki
Copy link

codesandbox bot commented Sep 3, 2024

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

@olivierodo olivierodo marked this pull request as draft September 3, 2024 07:32
@olivierodo olivierodo changed the title Github Action: Continuous integration to check link validity. Draft: Github Action: Continuous integration to check link validity. Sep 3, 2024
@olivierodo
Copy link
Author

The PR has been tagged as draft. I'm waiting for your feedback to know if you are interested by this feature then I can start fixing all the broken link.

cool

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant