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

Feature : Added linkChecker workflow #604

Merged
merged 2 commits into from
Apr 30, 2024

Conversation

aialok
Copy link
Collaborator

@aialok aialok commented Mar 25, 2024

What kind of change does this PR introduce?

  • Feature : This PR introduces a workflow to validate broken links.

Issue Number:

Screenshots/videos:

  • Automatic issue created by workflows

image

If relevant, did you update the documentation?

Summary

  • This workflow is intended to check for broken links periodically.
  • It will inspect all external links for validity.
  • Requests returning status codes 200, 201, 429, and 403 will be considered acceptable.
  • If any broken links are identified, corresponding issues will be created.

Does this PR introduce a breaking change?

@aialok aialok requested a review from a team as a code owner March 25, 2024 19:49
@aialok
Copy link
Collaborator Author

aialok commented Mar 27, 2024

@benjagm , this is ready for review.
Please review this in your free time.

Thank you : )

@Relequestual
Copy link
Member

Relequestual commented Apr 2, 2024

I don't think we should do this.
I am only one opinion though =]

@benjagm
Copy link
Collaborator

benjagm commented Apr 2, 2024

I don't think we should do this. I am only one opinion though =]

Can you elaborate Ben? My only concern is how often we run this workflow and what to do with the results found.

Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some questions and proposals.

Great work Alok!

.github/workflows/links.yml Outdated Show resolved Hide resolved
.github/workflows/links.yml Show resolved Hide resolved
.github/workflows/links.yml Outdated Show resolved Hide resolved
@aialok
Copy link
Collaborator Author

aialok commented Apr 15, 2024

Left some questions and proposals.

Great work Alok!

Thanks for the review. I will be making the suggested changes : )

@aialok
Copy link
Collaborator Author

aialok commented Apr 16, 2024

All suggested changes have been implemented:

  • This workflow will now run monthly and manually when needed.
  • It will create an issue with the link checker report if it does not exist; otherwise, it will update the existing issue.
  • We can manually run this workflow on every PR if needed.

Please manually run this workflow to check whether it is working fine or not.

I have run it on my local dummy repo its working fine.

image

Thank you : )

@aialok aialok requested a review from benjagm April 16, 2024 10:00
@aialok
Copy link
Collaborator Author

aialok commented Apr 22, 2024

@benjagm , This is ready to review again. Please review.

Thank you : )

Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Great work!

@benjagm benjagm merged commit 24d3c4a into json-schema-org:main Apr 30, 2024
2 checks passed
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.

Improve the CI/CD pipeline to avoid broken links
3 participants