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

Adds automated link checking and fixes broken links #15

Merged
merged 6 commits into from Oct 31, 2023

Conversation

vishnuravi
Copy link
Member

@vishnuravi vishnuravi commented Oct 29, 2023

Adds automated link checking and fixes broken links

♻️ Current situation & Problem

This PR adds automated link checking of all markdown files and fixes broken links. The check will run on all pull requests and automatically on the first of each month at midnight.

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

@codecov
Copy link

codecov bot commented Oct 29, 2023

Codecov Report

Merging #15 (32d4747) into main (58f79a2) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #15   +/-   ##
=======================================
  Coverage   91.65%   91.65%           
=======================================
  Files           6        6           
  Lines         431      431           
=======================================
  Hits          395      395           
  Misses         36       36           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 58f79a2...32d4747. Read the comment docs.

Copy link
Member

@PSchmiedmayer PSchmiedmayer left a comment

Choose a reason for hiding this comment

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

Thank you for the fix @vishnuravi!

Similarly to Spezi-Storage: Can we use the chance to directly add the URL link check to this PR?

I would suggest that we add this for every PR and in addition maybe as automated checks that run every month, e.g., on the first of the month? We should make this consistent across the different Spezi Modules as we update them with different PRs that make documentation or functionality-related changes.

https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule

@vishnuravi vishnuravi changed the title Updates initial setup link Adds automated link checking and fixes broken links Oct 31, 2023
Copy link
Member

@PSchmiedmayer PSchmiedmayer left a comment

Choose a reason for hiding this comment

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

Thank you; looks great! 🚀

@vishnuravi vishnuravi enabled auto-merge (squash) October 31, 2023 17:43
@vishnuravi vishnuravi merged commit d3db2a6 into main Oct 31, 2023
8 checks passed
@vishnuravi vishnuravi deleted the fix-broken-link branch October 31, 2023 19:19
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.

None yet

2 participants