valkyrjaio / valkyrja-java / 30742872287

100%

push

github

[Workflow] ci: Add the Markdown formatting check (#119)

# Description

Markdown was the one file type that no gate in this repository read.
Every CI tool here reads this
repository's own language, so a Markdown defect merges green.
valkyrjaio/valkyrja-php#1099 widened the first column of a table and
left the six rows below it
un-padded, the full gate passed, and a person repaired the table by hand
in
valkyrjaio/valkyrja-php#1104.

This pull request adds the `markdown-check` job to `ci.yml`. The job
calls
`_markdown-check.yml`, the language-agnostic reusable workflow added in
valkyrjaio/.github#231. It
runs Prettier over the Markdown this repository tracks, fails on drift,
and comments with the exact
fix command and the list of unformatted files. It removes that comment
when the check passes.

The job sits directly after `trailing-newline-check`, because both are
file hygiene that no
language owns, and it produces the check context `Markdown Check / Check
Markdown`.

The documents in this repository were normalized first, so this pull
request starts green.

## The check was proven end to end before this rollout

valkyrjaio/.github#232 reproduced the PR #1099 defect deliberately. Four
behaviors were confirmed
against real CI:

1. The check fails on the drift.
2. The comment lists the unformatted file.
3. A second failure deletes the old comment and posts a new one.
4. A passing run deletes the comment.

## Running it locally

```bash
git ls-files -z -- '*.md' ':(exclude)*CHANGELOG.md' \
  | xargs -0 npx --yes prettier@3.9.6 \
    --no-config \
    --embedded-language-formatting=off \
    --prose-wrap=preserve \
    --write
```

Replace `--write` with `--list-different` to see what would change
without changing it.

## This check is required

`Markdown Check / Check Markdown` is in `rulesets/Required Default PR
Checks.json`. A required
check that never reports blocks a pull request, so this job has to exist
here before
`enforce-repo-settings.yml` next a... (continued)

1929 of 1929 branches covered (100.0%)

Branch coverage included in aggregate %.

7056 of 7056 relevant lines covered (100.0%)

4.33 hits per line