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

Check links one time per week #16

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

RaheemAmer
Copy link
Member

Reason

This PR is made on #9's suggestion

Source

Feedback

Happy to hear and discuss any feedback, cheers ❤️

markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
Copy link

@eddiejaoude eddiejaoude Sep 20, 2022

Choose a reason for hiding this comment

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

main is the default branch, however release v3 is recommended to use https://github.com/actions/checkout

Copy link
Member Author

Choose a reason for hiding this comment

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

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)

image

Preview (2)

image

Choose a reason for hiding this comment

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

I think any release is better than using a branch


on:
schedule:
- cron: "0 13 * * 1"

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

@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

Choose a reason for hiding this comment

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

Copy link
Member Author

@RaheemAmer RaheemAmer Sep 21, 2022

Choose a reason for hiding this comment

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

@eddiejaoude
You're right, it's from this article

Preview on the reason why this line exists

image

Choose a reason for hiding this comment

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

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.

Choose a reason for hiding this comment

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

Great to have comments 👍 but I think this will cause the file to be invalid

Copy link
Member Author

Choose a reason for hiding this comment

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

@eddiejaoude
My bad, you're definitely right 👍🏻

Copy link

@eddiejaoude eddiejaoude left a comment

Choose a reason for hiding this comment

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

Interesting GitHub Action, I didn't know about it, so thank you 👍 .

I added a few comments, any questions let me know 🤓

Copy link
Member

@EmmaDawsonDev EmmaDawsonDev left a comment

Choose a reason for hiding this comment

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

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.

@RaheemAmer
Copy link
Member Author

RaheemAmer commented Sep 21, 2022

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

image

@RaheemAmer
Copy link
Member Author

Interesting GitHub Action, I didn't know about it, so thank you 👍 .

I added a few comments, any questions let me know 🤓

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
@RaheemAmer
Copy link
Member Author

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
@eddiejaoude

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 ❤️

Copy link
Contributor

@CBID2 CBID2 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 @RaheemAmer!

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.

4 participants