CICD pipelines to include Markdown link check

[mmitoraj]

Created on 2023-08-17 by Małgorzata Świeca (@mmitoraj).

Decision log

Name	Description
Title	CICD pipelines to include Markdown link check
Due date	2023-09-01
Status	Proposed on 2023-08-17, Accepted on 2023-09-02
Decision type	Choice
Affected decisions	#822(depends on)

Context

Accepting the Use Markdown Link Check as a product quality check decision means implementing and setting up the Markdown link check in the kyma-project repositories. How each team will implement that check in their repo is another decision to be made. In the PoC, Huskies implemented the check using GitHub Actions (GitHub Actions - Markdown link check from the Actions Marketplace. However, it could be also set up using Prow.

Decision

If the Use Markdown Link Check as a product quality check decision is accepted, it will require implementation and CICD pipelines setup. The decision is to choose either GitHub Actions, Prow, or other CICD pipeline for your repository.

NOTE: Remember that the check should be conducted on two levels:

1. PR level - checking links in markdown files being part of the created PR
2. Repository level - checking links in all markdown files in a repository. This would be a periodic, daily check scheduled on the main branch. Read more details on how to schedule GitHub Actions.

For release purposes, a smoke test needs to be added to the Azure DevOps submission pipeline by the Neighbours team.

Consequences

• Repository Owners must set up the CIDC pipeline for the Markdown link check
• Repository Owners must take care of fixing broken links detected by the Markdown link check
• @kyma-project/technical-writers will fix broken links detected in the /kyma repository.
• The Neighbours team will add a smoke test to the Azure DevOps submission pipeline.

[mmitoraj]

Accepted