Rename dockercheck to check and check to localcheck (#1244)
## Description Followup for https://github.com/alcionai/corso/pull/1240 ## Type of change <!--- Please check the type of change your PR introduces: ---> - [ ] 🌻 Feature - [ ] 🐛 Bugfix - [x] 🗺️ Documentation - [ ] 🤖 Test - [x] 💻 CI/Deployment - [ ] 🐹 Trivial/Minor ## Issue(s) <!-- Can reference multiple issues. Use one of the following "magic words" - "closes, fixes" to auto-close the Github issue. --> * https://github.com/alcionai/corso/pull/1240 ## Test Plan <!-- How will this be tested prior to merging.--> - [x] 💪 Manual - [ ] ⚡ Unit test - [ ] 💚 E2E
This commit is contained in:
parent
526f5d542d
commit
97791a6787
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
@ -96,7 +96,7 @@ jobs:
|
||||
env:
|
||||
CORSO_USE_DOCKER: -1 # prevent using docker inside makefile
|
||||
run: |
|
||||
cd docs && make -o genclidocs check
|
||||
cd docs && make -o genclidocs localcheck
|
||||
|
||||
# ----------------------------------------------------------------------------------------------------
|
||||
# --- Integration and Unit Testing -------------------------------------------------------------------
|
||||
|
||||
@ -8,16 +8,12 @@ CORSO_REPO := /go/src/github.com/alcionai/corso
|
||||
CORSO_LOCAL_PATH := $(shell git rev-parse --show-toplevel)
|
||||
CORSO_VERSION := $(shell git rev-parse --short HEAD)
|
||||
DOCSC := docker run --rm -it -p 3000:3000 -v ${PWD}:/usr/src/docs --env CORSO_VERSION=${CORSO_VERSION} corso/docs
|
||||
GOC := docker run --rm -it \
|
||||
CBASE := docker run --rm -it \
|
||||
-v ${CORSO_LOCAL_PATH}:${CORSO_REPO} -v ${CORSO_BUILD_DIR}:${CORSO_BUILD_DIR} \
|
||||
--env GOCACHE=${CORSO_BUILD_CACHE} --env GOMODCACHE=${CORSO_BUILD_MOD} --env GOTMPDIR=${CORSO_BUILD_DIR} \
|
||||
--workdir ${CORSO_REPO}/src \
|
||||
golang:1.18
|
||||
GOBASHC := docker run --rm -it \
|
||||
-v ${CORSO_LOCAL_PATH}:${CORSO_REPO} -v ${CORSO_BUILD_DIR}:${CORSO_BUILD_DIR} \
|
||||
--env GOCACHE=${CORSO_BUILD_CACHE} --env GOMODCACHE=${CORSO_BUILD_MOD} --env GOTMPDIR=${CORSO_BUILD_DIR} \
|
||||
--workdir ${CORSO_REPO}/src --entrypoint bash \
|
||||
golang:1.18
|
||||
--workdir ${CORSO_REPO}/src
|
||||
GOC := ${CBASE} golang:1.18
|
||||
GOBASHC := ${CBASE} --entrypoint bash golang:1.18
|
||||
MDGEN_SRC := ${CORSO_REPO}/src/cmd/mdgen/mdgen.go
|
||||
MDGEN_BINARY := ${CORSO_BUILD_BIN}/mdgen
|
||||
CLI_DOCS := ${CORSO_REPO}/docs/docs/cli
|
||||
@ -31,13 +27,13 @@ dev: genclidocs
|
||||
VALE_TARGET ?= docs README.md
|
||||
|
||||
check: genclidocs
|
||||
vale $(VALE_TARGET)
|
||||
markdownlint '**/*.md' --ignore styles/ --ignore src/ --ignore node_modules/
|
||||
|
||||
dockercheck: genclidocs
|
||||
$(DOCSC) vale $(VALE_TARGET)
|
||||
$(DOCSC) markdownlint '**/*.md' --ignore styles/ --ignore src/ --ignore node_modules/
|
||||
|
||||
localcheck: genclidocs
|
||||
vale $(VALE_TARGET)
|
||||
markdownlint '**/*.md' --ignore styles/ --ignore src/ --ignore node_modules/
|
||||
|
||||
dockershell:
|
||||
$(DOCSC) bash
|
||||
|
||||
|
||||
@ -45,9 +45,9 @@ This command generates static content into the `build` directory for integration
|
||||
|
||||
```bash
|
||||
# Lint all docs
|
||||
make dockercheck
|
||||
make check
|
||||
# Lint specific files and/or folders
|
||||
make dockercheck VALE_TARGET="README.md docs/concepts"
|
||||
make check VALE_TARGET="README.md docs/concepts"
|
||||
```
|
||||
|
||||
This command will lint all Markdown files and check them for style issues using the Docker container
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user