StanfordSpezi / SpeziBluetooth

Connect and communicate with Bluetooth devices.
https://swiftpackageindex.com/StanfordSpezi/SpeziBluetooth/documentation/spezibluetooth
MIT License
11 stars 2 forks source link

Adds automated link checking and fixes broken links #6

Closed vishnuravi closed 10 months ago

vishnuravi commented 10 months ago

Adds automated link checking and fixes broken links

:recycle: 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.

:pencil: Code of Conduct & Contributing Guidelines

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

codecov[bot] commented 10 months ago

Codecov Report

Merging #6 (20d4814) into main (b51eef6) will not change coverage. The diff coverage is n/a.

:exclamation: Current head 20d4814 differs from pull request most recent head c86d1ee. Consider uploading reports for the commit c86d1ee to get more accurate results

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/StanfordSpezi/SpeziBluetooth/pull/6/graphs/tree.svg?width=650&height=150&src=pr&token=mgZAjyPJH4&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi)](https://app.codecov.io/gh/StanfordSpezi/SpeziBluetooth/pull/6?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ```diff @@ Coverage Diff @@ ## main #6 +/- ## ======================================= Coverage 10.46% 10.46% ======================================= Files 5 5 Lines 373 373 ======================================= Hits 39 39 Misses 334 334 ``` ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/StanfordSpezi/SpeziBluetooth/pull/6?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/StanfordSpezi/SpeziBluetooth/pull/6?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Last update [b51eef6...c86d1ee](https://app.codecov.io/gh/StanfordSpezi/SpeziBluetooth/pull/6?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi).
vishnuravi commented 10 months ago

Thank you for the fix @vishnuravi! 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?

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

Thanks for the feedback @PSchmiedmayer. Markdown link checks have been added here, automated checks have been added on the first of every month, and the PR has been updated to reflect that.

PSchmiedmayer commented 10 months ago

Added some comments over in the other PR. Thanks for improving this here! 🚀