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

Add GitHub action to check markdown files for broken links #214

Closed
Tracked by #161
morri-son opened this issue Jun 19, 2024 · 1 comment · Fixed by open-component-model/ocm#871 or open-component-model/ocm-website#308
Labels
area/documentation Documentation related area/ipcei Important Project of Common European Interest area/quality Output qualification (tests, checks, scans, automation in general, etc.) related kind/feature new feature, enhancement, improvement, extension kind/good-first-issue Good for newcomers

Comments

@morri-son
Copy link
Contributor

morri-son commented Jun 19, 2024

What would you like to be added:
Add GitHub action to check markdown files for broken links, e.g. Add GitHub action to check markdown files for broken links or anything else suitable. Ideally the actions should be executed on every push to main and added to the required tests on a PR, but depending on how long it runs, we may just schedule it.

Why is this needed:
To avoid dead links in any of our markdown documentation files in any of the repositories, we should add a Github action that checks for dead links to all repositories.

linked to #161

@morri-son morri-son added area/documentation Documentation related area/quality Output qualification (tests, checks, scans, automation in general, etc.) related kind/feature new feature, enhancement, improvement, extension labels Jun 19, 2024
@morri-son morri-son added the area/ipcei Important Project of Common European Interest label Jun 19, 2024
@hilmarf
Copy link
Member

hilmarf commented Jun 19, 2024

e.g. https://github.com/corona-warn-app/cwa-server/blob/main/.github/workflows/markdown-analysis.yml#L27

@morri-son morri-son added the kind/good-first-issue Good for newcomers label Jul 3, 2024
@hilmarf hilmarf linked a pull request Aug 23, 2024 that will close this issue
@hilmarf hilmarf moved this from 🆕 ToDo to 🏗 In Progress in OCM Backlog Board Aug 23, 2024
@hilmarf hilmarf added this to the 2024-Q3 milestone Aug 23, 2024
@github-project-automation github-project-automation bot moved this from 🏗 In Progress to 🍺 Done in OCM Backlog Board Sep 16, 2024
@ocmbot ocmbot bot moved this from 🍺 Done to 🔒Closed in OCM Backlog Board Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation related area/ipcei Important Project of Common European Interest area/quality Output qualification (tests, checks, scans, automation in general, etc.) related kind/feature new feature, enhancement, improvement, extension kind/good-first-issue Good for newcomers
Projects
Status: 🔒Closed
2 participants