Skip to content

chore: check for invalid markdown links in docs weekly #6795

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

Merged
merged 13 commits into from
Apr 7, 2023
Merged

chore: check for invalid markdown links in docs weekly #6795

merged 13 commits into from
Apr 7, 2023

Conversation

matifali
Copy link
Member

As per #6793, there are multiple broken links in our docs. This action will check if all markdown links are valid.

cc: @ammario @bpmct

As per #6793, there are multiple broken links in our docs. This action will check if all markdown links are valid.

cc: @ammario @bpmct
@ammario
Copy link
Member

ammario commented Mar 25, 2023

We had this before but it was flakey since requests randomly timed out in CI.

@matifali
Copy link
Member Author

Ok. You can close it. From now on, we can be more careful with links and should test manually before pushing.

I can close as not planned. Your call.

@ammario
Copy link
Member

ammario commented Mar 25, 2023

Maybe do this as an actions cron for now? We can probably have it notify a slack channel.

@matifali
Copy link
Member Author

To post to a slack channel, I will probably need some help from the team. https://github.com/slackapi/slack-github-action

@matifali matifali changed the title chore(ci): add an automatic check to verify markdown links. chore(ci): check and forward invalid markdown links in docs to slack Mar 27, 2023
@matifali matifali marked this pull request as draft March 27, 2023 20:34
@matifali matifali changed the title chore(ci): check and forward invalid markdown links in docs to slack chore: check and forward invalid markdown links in docs to slack Mar 27, 2023
@matifali matifali marked this pull request as ready for review March 27, 2023 21:30
@matifali matifali marked this pull request as draft March 27, 2023 21:45
@matifali
Copy link
Member Author

It turns out that the link check action does not have any outputs, so a workaround will be to follow the steps,

  1. Run Markdown Link check workflow and save the workflow log
  2. Run another workflow that runs when 1. completes, parses the log and send a message to slack.

Any other ideas?

@matifali matifali changed the title chore: check and forward invalid markdown links in docs to slack chore: check for invalid markdown links in docs weekly Mar 27, 2023
@matifali
Copy link
Member Author

This is a partial solution, as we have to check the output of this workflow every week. I plan to set up slack integration in a separate PR after I find out how to use this action's output instead of saving logs, parsing, and running another workflow to post that to slack.

Merging this will at least give us timely reports if there are any invalid links.

@matifali matifali marked this pull request as ready for review March 27, 2023 22:11
@matifali
Copy link
Member Author

@bpmct suggested posting a message to slack when this workflow runs. We can check the logs on GitHub.

@matifali
Copy link
Member Author

matifali commented Apr 3, 2023

Can it be merged as it is unharmful and will provide us with useful insights on the docs? @bpmct

@bpmct bpmct enabled auto-merge (squash) April 7, 2023 16:37
@bpmct bpmct merged commit 7e530b0 into coder:main Apr 7, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Apr 7, 2023
@matifali matifali deleted the patch-2 branch April 7, 2023 20:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants