search

corona-warn-app / cwa-website

Corona-Warn-App website. The CWA development ended on May 31, 2023. You still can warn other users until April 30, 2023. More information:
https://coronawarn.app/en/faq/#ramp_down
Apache License 2.0
521 stars 224 forks source link

Add a workflow to check Markdown links #3407

Closed MikeMcC399 closed 1 year ago

MikeMcC399 commented 1 year ago

This is a suggestion to add a workflow to check Markdown links.

Current situation

The local command

npm run checklinks

is available to check links in Markdown documents such as the README file which are targeted at contributors and maintainers of the repository.

There is however no automated trigger to run this check.

(Note that Markdown documents which are website source documents are already checked through a separate process after they are transformed into HTML pages.)

Suggestion

Add a new workflow to .github/workflows to run the checklinks script to check links in Markdown documents.

Internal Tracking ID: EXPOSUREAPP-14845

MikeMcC399 commented 1 year ago

Please let me know if you would like a workflow for this and I will submit a new PR.

larswmh commented 1 year ago

Hey @MikeMcC399, thanks for offering your assistance on this. We would appreciate if you could provide a PR for this. I've just merged the PR mentioned in your previous comment

MikeMcC399 commented 1 year ago

@larswmh

Thank you for your confirmation! I did want to check with you before I opened a PR.