Add markdownlint to Makefile
We're currently running markdownlint in CI and we didn't have a target for that in our makefile. Adding that to prevent rejected PR's due to markdown linting errors Signed-off-by: Marcos Lilljedahl <marcosnils@gmail.com>
This commit is contained in:
parent
b47b51401f
commit
b401cdafd9
8
Makefile
8
Makefile
@ -42,14 +42,14 @@ cuefmt: # Format all cue files
|
|||||||
|
|
||||||
.PHONY: cuelint
|
.PHONY: cuelint
|
||||||
cuelint: cuefmt # Lint and format all cue files
|
cuelint: cuefmt # Lint and format all cue files
|
||||||
@test -z "$$(git status -s . | grep -e "^ M" | grep .cue | cut -d ' ' -f3 | tee /dev/stderr)"
|
@test -z "$$(git status -s . | grep -e "^ M" | grep "\.cue" | cut -d ' ' -f3 | tee /dev/stderr)"
|
||||||
|
|
||||||
.PHONY: shellcheck
|
.PHONY: shellcheck
|
||||||
shellcheck: # Run shellcheck
|
shellcheck: # Run shellcheck
|
||||||
shellcheck $$(find . -type f \( -iname \*.bats -o -iname \*.bash -o -iname \*.sh \) -not -path "*/node_modules/*" -not -path "*/bats-*/*")
|
shellcheck $$(find . -type f \( -iname \*.bats -o -iname \*.bash -o -iname \*.sh \) -not -path "*/node_modules/*" -not -path "*/bats-*/*")
|
||||||
|
|
||||||
.PHONY: lint
|
.PHONY: lint
|
||||||
lint: shellcheck cuelint golint docslint # Lint everything
|
lint: shellcheck cuelint golint docslint mdlint # Lint everything
|
||||||
|
|
||||||
.PHONY: integration
|
.PHONY: integration
|
||||||
integration: core-integration universe-test doc-test # Run all integration tests
|
integration: core-integration universe-test doc-test # Run all integration tests
|
||||||
@ -82,6 +82,10 @@ docs: dagger # Generate docs
|
|||||||
docslint: docs # Generate & lint docs
|
docslint: docs # Generate & lint docs
|
||||||
@test -z "$$(git status -s . | grep -e "^ M" | grep docs/reference | cut -d ' ' -f3 | tee /dev/stderr)"
|
@test -z "$$(git status -s . | grep -e "^ M" | grep docs/reference | cut -d ' ' -f3 | tee /dev/stderr)"
|
||||||
|
|
||||||
|
.PHONY: mdlint
|
||||||
|
mdlint: # Markdown lint for web
|
||||||
|
@markdownlint ./docs README.md
|
||||||
|
|
||||||
.PHONY: web
|
.PHONY: web
|
||||||
web: # Run the website locally
|
web: # Run the website locally
|
||||||
yarn --cwd "./website" install
|
yarn --cwd "./website" install
|
||||||
|
@ -147,7 +147,7 @@ Bob:
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The output here is a product of _*unifying*_ the `#Person` _definition_ with an object that contains _concrete values_ each of which is the product of unifying the concrete value with the _types_ and _constraints_ declared by the field in the definition. [Try it in the CUE playground](https://cuelang.org/play/?id=nAUx1-VlrY4#cue@export@yaml)
|
The output here is a product of _unifying_ the `#Person` _definition_ with an object that contains _concrete values_ each of which is the product of unifying the concrete value with the _types_ and _constraints_ declared by the field in the definition. [Try it in the CUE playground](https://cuelang.org/play/?id=nAUx1-VlrY4#cue@export@yaml)
|
||||||
|
|
||||||
### Default Values and the Nature of Inheritance
|
### Default Values and the Nature of Inheritance
|
||||||
|
|
||||||
|
@ -13,9 +13,9 @@ Within 5 minutes, you will have a local CI/CD loop and run your first test & bui
|
|||||||
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
|
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
<Tabs defaultValue={
|
<Tabs defaultValue={
|
||||||
window.navigator.userAgent.indexOf('Linux') != -1 ? 'linux':
|
window.navigator.userAgent.indexOf('Linux') != -1 ? 'linux':
|
||||||
window.navigator.userAgent.indexOf('Win') != -1 ? 'windows':
|
window.navigator.userAgent.indexOf('Win') != -1 ? 'windows':
|
||||||
'macos'}
|
'macos'}
|
||||||
groupId="os"
|
groupId="os"
|
||||||
values={[
|
values={[
|
||||||
{label: 'macOS', value: 'macos'}, {label: 'Linux', value: 'linux'}, {label: 'Windows', value: 'windows'},
|
{label: 'macOS', value: 'macos'}, {label: 'Linux', value: 'linux'}, {label: 'Windows', value: 'windows'},
|
||||||
|
@ -147,7 +147,7 @@ Bob:
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The output here is a product of _*unifying*_ the `#Person` _definition_ with an object that contains _concrete values_ each of which is the product of unifying the concrete value with the _types_ and _constraints_ declared by the field in the definition. [Try it in the CUE playground](https://cuelang.org/play/?id=nAUx1-VlrY4#cue@export@yaml)
|
The output here is a product of _unifying_ the `#Person` _definition_ with an object that contains _concrete values_ each of which is the product of unifying the concrete value with the _types_ and _constraints_ declared by the field in the definition. [Try it in the CUE playground](https://cuelang.org/play/?id=nAUx1-VlrY4#cue@export@yaml)
|
||||||
|
|
||||||
### Default Values and the Nature of Inheritance
|
### Default Values and the Nature of Inheritance
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user