From 97791a6787272fe1e3adb20d02a006e942b16029 Mon Sep 17 00:00:00 2001 From: Abin Simon Date: Thu, 20 Oct 2022 10:44:13 +0530 Subject: [PATCH] Rename dockercheck to check and check to localcheck (#1244) ## Description Followup for https://github.com/alcionai/corso/pull/1240 ## Type of change - [ ] :sunflower: Feature - [ ] :bug: Bugfix - [x] :world_map: Documentation - [ ] :robot: Test - [x] :computer: CI/Deployment - [ ] :hamster: Trivial/Minor ## Issue(s) * https://github.com/alcionai/corso/pull/1240 ## Test Plan - [x] :muscle: Manual - [ ] :zap: Unit test - [ ] :green_heart: E2E --- .github/workflows/ci.yml | 2 +- docs/Makefile | 20 ++++++++------------ docs/README.md | 4 ++-- 3 files changed, 11 insertions(+), 15 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a37695cce..ff67dfc65 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -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 ------------------------------------------------------------------- diff --git a/docs/Makefile b/docs/Makefile index a7db35d63..c57de2bd7 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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 diff --git a/docs/README.md b/docs/README.md index 9ec70aacd..916d52f84 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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