CI: Introduce link checker job #2844
Conversation
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## main #2844 +/- ##
==========================================
+ Coverage 82.44% 91.07% +8.63%
==========================================
Files 152 160 +8
Lines 2945 3329 +384
Branches 187 296 +109
==========================================
+ Hits 2428 3032 +604
+ Misses 517 297 -220 see 166 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
| @@ -191,7 +191,6 @@ pipelines: | |||
| There is multiple articles on how to run Scala Steward on-premise: | |||
|
|
|||
| * [Running Scala Steward On-premise](https://engineering.avast.io/running-scala-steward-on-premise) | |||
| * [Running scala-steward periodically on AWS Fargate](https://medium.com/@tanishiking/running-scala-steward-periodically-on-aws-fargate-3d3d202f0f7) | |||
There was a problem hiding this comment.
This blog appears to be gone.
|
This is great! Could we also run this on a schedule like once per week or so? It would then notify us about broken links (like those replaced in #2842) in a timely manner without the need that somebody touches these files in a PR. |
docs/scalafix-migrations.md
Outdated
| @@ -13,10 +13,13 @@ Here are two pull requests that demonstrate this feature: | |||
| And here are all pull requests where Scala Steward applied Scalafix | |||
| migrations: | |||
|
|
|||
| <!-- These links exists but returns 404 often so skip check --> | |||
There was a problem hiding this comment.
The pulls URLs require that the user is logged into GitHub. I guess this is why they are reported as dead.
.github/workflows/linkcheck.yml
Outdated
| - uses: actions/checkout@v2 | ||
| with: | ||
| fetch-depth: 0 | ||
| - uses: gaurav-nelson/github-action-markdown-link-check@v1 |
There was a problem hiding this comment.
Note) I am waiting gaurav-nelson/github-action-markdown-link-check#168 to be released
Otherwise, the GH action checks not only files in docs but also in module/docs/mdoc/~ which contains vairables in links.
Follow-up of #2842
~.mdare changed, so false alerts due to tentative network failure are less likely to happenhttps://github.com/gaurav-nelson/github-action-markdown-link-check is used since it is highly starred in this area and its README are well-written.
Also fixed some "broken" links found in test runs.
Example
Failure
https://github.com/exoego/scala-steward/actions/runs/3746779243/jobs/6362385292
Succcess
https://github.com/exoego/scala-steward/actions/runs/3746849923/jobs/6362522900
