pipe-cd/pipecd

ci(docs): Add link checker to existing CI to prevent broken docs links

Ouverte

#6 549 ouverte le 26 févr. 2026

Voir sur GitHubGuide contributeur
 (6 commentaires) (1 réaction) (1 personne assignée)Go (319 forks)auto 404
area/cigood first issuetype/feature

Métriques du dépôt

Stars
 (1 329 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

Add a lightweight link-checking step to the existing CI workflow that runs only when docs or README files change. This would fail PRs if there are broken external links, helping catch issues early and reducing manual review overhead for maintainers.

What would you like to be added:

Why is this needed:

Guide contributeur

Direction de recherche
Inspectez les fichiers de workflow CI existants dans le répertoire .github/workflows. Identifiez le workflow qui compile ou teste la documentation. Recherchez des outils de vérification de liens comme lychee ou markdown link check et apprenez à ajouter une nouvelle étape qui ne s'exécute que lorsque les fichiers docs/README changent. Comprenez comment garantir que la vérification échoue en cas de liens cassés.
Stack technique
github actions
Domaine
ci cddevops
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
GitGitHub Actions
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75