Check links one time per week #16
Conversation
.github/workflows/checklinks.yml
Outdated
| markdown-link-check: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@master |
There was a problem hiding this comment.
main is the default branch, however release v3 is recommended to use https://github.com/actions/checkout
There was a problem hiding this comment.
Thank you so much, I have a question on the v3, when you search for the latest version, it shows v2.4.2, but when I choose any v3 it tells me to use the latest version instead, so what do you recommend me to do?
Preview (1)
Preview (2)
There was a problem hiding this comment.
I think any release is better than using a branch
.github/workflows/checklinks.yml
Outdated
|
|
||
| on: | ||
| schedule: | ||
| - cron: "0 13 * * 1" |
There was a problem hiding this comment.
Probably best to run this on use trigger rather than the cron, so the user can get immediate feedback
Something like
on:
push https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push
There was a problem hiding this comment.
I think the idea is to check through all the links once a week hence the cron, but maybe a trigger on push would be useful as well.
There was a problem hiding this comment.
@eddiejaoude @EmmaDawsonDev
Definitely a very good suggestion 👍🏻
| steps: | ||
| - uses: actions/checkout@master | ||
| - uses: gaurav-nelson/github-action-markdown-link-check@v1 | ||
| continue-on-error: true |
There was a problem hiding this comment.
I couldn't see this option in the docs? https://github.com/gaurav-nelson/github-action-markdown-link-check#custom-variables
There was a problem hiding this comment.
There was a problem hiding this comment.
Not sure if it is still available on the Action, might need to dig deeper.
If it is available, it is probably best for @EmmaDawsonDev to decide if she prefers failure or report only
mlc_config.json
Outdated
| @@ -0,0 +1,6 @@ | |||
| // 429 Too Many Requests | |||
| // This is the typical github answer after too much requests, so I would like to ignore this status when it happens. | |||
There was a problem hiding this comment.
Great to have comments 👍 but I think this will cause the file to be invalid
There was a problem hiding this comment.
@eddiejaoude
My bad, you're definitely right 👍🏻
There was a problem hiding this comment.
Thanks for your contribution @RaheemAmer . I'm not too familiar with github actions yet so I'm curious to know where the results of this action end up so that I can action any links that no longer work.
My pleasure ❤️ @EmmaDawsonDev , It's gonna produce something similar to this Preview
|
You're most welcome ❤️ @eddiejaoude and also thank you so much for your comments and review, I'll recheck your comments and start working on the PR |
## Changes - From using cron to using push - Changed branch from master to main - Updated the version of the checkout action into the latest version available - Added quiet and verbose mode to offer more detailed info, [Check Custom variables Table](https://github.com/gaurav-nelson/github-action-markdown-link-check#custom-variables) - Added config file path, forgot to add it
## Reason - May cause the file to be invalid
|
I've done all the changes except changing into using checkout rather than a branch, I'm having a little bit of confusion on what to write exactly, so any help will be more than welcome, other than this everything is crystal clear and @EmmaDawsonDev Could you please inform me whether you want or prefers failure or report only regarding this issue #16 (comment) Thank you so much for your time, effort and cooperation, and I'm sorry if I did anything wrong. I'm still learning ❤️ |
Reason
This PR is made on #9's suggestion
Source
Feedback
Happy to hear and discuss any feedback, cheers ❤️