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

fix: modify the markdown check from local to call markdown check in catalyst-ci #29

Merged
merged 5 commits into from
Dec 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 0 additions & 14 deletions .github/workflows/markdown-check.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .markdownlint.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
},
// MD042/no-empty-links - No empty links
"MD042": true,
// MD043/required-headings/required-headers - Required heading structure
// MD043/required-headings/required-headings - Required heading structure
"MD043": {
// List of headings
"headings": [
Expand Down
4 changes: 2 additions & 2 deletions .vscode/tasks.recommended.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{
"label": "CI - Recursive Markdown Lint - Check",
"type": "shell",
"command": "earthly -P +markdown-check",
"command": "earthly -P +check-markdoqn",
"problemMatcher": {
"owner": "markdown-check",
"pattern": {
Expand All @@ -24,7 +24,7 @@
"type": "shell",
"command": "earthly -P +markdown-check-fix",
"problemMatcher": {
"owner": "markdown-check",
"owner": "markdown-check-fix",
"pattern": {
"regexp": "(\\S+):(\\d+):(\\d+)\\s(.+)",
"file": 1,
Expand Down
13 changes: 6 additions & 7 deletions Earthfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,23 @@ FROM debian:stable-slim

# cspell: words livedocs sitedocs

markdown-check:
# Check Markdown in this repo.
LOCALLY

DO github.com/input-output-hk/catalyst-ci/earthly/mdlint:v1.3.0+MDLINT_LOCALLY --src=$(echo ${PWD})
# check-markdown markdown check using catalyst-ci.
check-markdown:
DO github.com/input-output-hk/catalyst-ci/earthly/mdlint:v2.0.10+CHECK

# markdown-check-fix markdown check and fix using catalyst-ci.
markdown-check-fix:
# Check Markdown in this repo.
LOCALLY

DO github.com/input-output-hk/catalyst-ci/earthly/mdlint:v1.3.0+MDLINT_LOCALLY --src=$(echo ${PWD}) --fix=--fix
DO github.com/input-output-hk/catalyst-ci/earthly/mdlint:v2.0.10+MDLINT_LOCALLY --src=$(echo ${PWD}) --fix=--fix

# check-spelling Check spelling in this repo inside a container.
check-spelling:
DO github.com/input-output-hk/catalyst-ci/earthly/cspell:v2.0.10+CHECK

check:
BUILD +check-spelling
BUILD +check-markdown

repo-docs:
# Create artifacts of extra files we embed inside the documentation when its built.
Expand Down