Skip to content

Commit

Permalink
chore: make markdown-link-check (celestiaorg#1957)
Browse files Browse the repository at this point in the history
  • Loading branch information
rootulp authored Jun 19, 2023
1 parent 91965ae commit c8f5c33
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
8 changes: 7 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ build-docker:
$(DOCKER) build -t celestiaorg/celestia-app -f docker/Dockerfile .
.PHONY: build-docker

## lint: Run linters golangci-lint and markdownlint.
## lint: Run all linters: golangci-lint, markdownlint, hadolint, yamllint.
lint:
@echo "--> Running golangci-lint"
@golangci-lint run
Expand All @@ -85,6 +85,12 @@ lint:

.PHONY: lint

## markdown-link-check: Check all markdown links.
markdown-link-check:
@echo "--> Running markdown-link-check"
@find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check


## fmt: Format files per linters golangci-lint and markdownlint.
fmt:
@echo "--> Running golangci-lint --fix"
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ See <https://docs.celestia.org/category/celestia-app> for more information
1. Install [markdownlint](https://github.com/DavidAnson/markdownlint)
1. Install [hadolint](https://github.com/hadolint/hadolint)
1. Install [yamllint](https://yamllint.readthedocs.io/en/stable/quickstart.html)
1. Install [markdown-link-check](https://github.com/tcort/markdown-link-check)

### Helpful Commands

Expand Down

0 comments on commit c8f5c33

Please sign in to comment.