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.

Sign up for GitHub

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
Open

Check links one time per week #16

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2c29140
Create checklinks.yml
RaheemAmer Sep 15, 2022
ecbc616
Create mlc_config.json
RaheemAmer Sep 15, 2022
613edda
Fixed few issues
RaheemAmer Sep 21, 2022
b4503bf
Removed Comments
RaheemAmer Sep 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/checklinks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Check Markdown links

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

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 👍🏻


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

@eddiejaoude eddiejaoude Sep 20, 2022 •
edited
Loading

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

Copy link

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

- uses: gaurav-nelson/github-action-markdown-link-check@v1
continue-on-error: true
Copy link

Choose a reason for hiding this comment

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

I couldn't see this option in the docs? https://github.com/gaurav-nelson/github-action-markdown-link-check#custom-variables

Copy link
Member Author

@RaheemAmer RaheemAmer Sep 21, 2022 •
edited
Loading

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

Copy link

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

6 changes: 6 additions & 0 deletions mlc_config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Copy link

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 👍🏻


{
"aliveStatusCodes": [429, 200]
}