mirror of
https://github.com/sigp/lighthouse.git
synced 2026-03-09 03:31:45 +00:00
fcfcbf9a11
Update the mdlint CI to ignore a newly introduced lint which is overly strict (IMO). Example failure: https://github.com/sigp/lighthouse/actions/runs/15102688734/job/42446029011?pr=7479 Ignore the new lint that requires link text to be descriptive. IMO it is completely fine to write links like `See docs [here](http://url.com)`.
25 lines
1.0 KiB
Bash
Executable File
25 lines
1.0 KiB
Bash
Executable File
#! /usr/bin/env bash
|
|
|
|
# IMPORTANT
|
|
# This script should NOT be run directly.
|
|
# Run `make mdlint` from the root of the repository instead.
|
|
|
|
# use markdownlint-cli to check for markdown files
|
|
# NOTE: we disable MD059 (descriptive-link-text) because it is too strict
|
|
docker run --rm -v ./book:/workdir ghcr.io/igorshubovych/markdownlint-cli:latest '**/*.md' --ignore node_modules --disable MD059
|
|
|
|
# exit code
|
|
exit_code=$(echo $?)
|
|
|
|
if [[ $exit_code == 0 ]]; then
|
|
echo "All markdown files are properly formatted."
|
|
exit 0
|
|
elif [[ $exit_code == 1 ]]; then
|
|
echo "Exiting with errors. Run 'make mdlint' locally and commit the changes. Note that not all errors can be fixed automatically, if there are still errors after running 'make mdlint', look for the errors and fix manually."
|
|
docker run --rm -v ./book:/workdir ghcr.io/igorshubovych/markdownlint-cli:latest '**/*.md' --ignore node_modules --fix
|
|
exit 1
|
|
else
|
|
echo "Exiting with exit code >1. Check for the error logs and fix them accordingly."
|
|
exit 1
|
|
fi
|