Skip to content

Commit 3d2c63c

Browse files
author
Andrew Welch
committed
refactor: Add comments to Makefiles for Fig
1 parent 207fd51 commit 3d2c63c

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

buildchain/Makefile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,30 @@ DOCKERRUN=docker container run \
1111

1212
.PHONY: build dev docker install clean npm
1313

14+
# Build the production assets
1415
build: docker install
1516
${DOCKERRUN} \
1617
run build
18+
# Start up the dev server
1719
dev: docker install
1820
${DOCKERRUN} \
1921
run dev
22+
# Start the Docker container
2023
docker:
2124
docker build \
2225
. \
2326
-t ${CONTAINER}:${TAG} \
2427
--build-arg TAG=${TAG} \
2528
--no-cache
29+
# Run an npm install
2630
install: docker
2731
${DOCKERRUN} \
2832
install
33+
# Remove node_modules/* & package-lock.json
2934
clean:
3035
rm -rf node_modules/
3136
rm -f package-lock.json
37+
# Run the passed in npm command
3238
npm: docker
3339
${DOCKERRUN} \
3440
$(filter-out $@,$(MAKECMDGOALS))

docs/Makefile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,32 +11,40 @@ DOCSDEST?=../../../sites/nystudio107/web/docs/transcoder
1111

1212
.PHONY: docker build dev fix install lint clean npm
1313

14+
# Start the Docker container
1415
docker:
1516
docker build \
1617
. \
1718
-t ${CONTAINER}:${TAG} \
1819
--build-arg TAG=${TAG} \
1920
--no-cache
21+
# Build the production docs
2022
build: docker install
2123
${DOCKERRUN} \
2224
run docs:build
2325
rm -rf ${DOCSDEST}
2426
mv ./docs/.vitepress/dist ${DOCSDEST}
27+
# Start up the dev server
2528
dev: docker install
2629
${DOCKERRUN} \
2730
run docs:dev
31+
# Fix the docs via textlint
2832
fix: docker install
2933
${DOCKERRUN} \
3034
run docs:fix
35+
# Run an npm install
3136
install: docker
3237
${DOCKERRUN} \
3338
install
39+
# Lint the docs via textlint
3440
lint: docker install
3541
${DOCKERRUN} \
3642
run docs:lint
43+
# Remove node_modules/* & package-lock.json
3744
clean:
3845
rm -rf node_modules/
3946
rm -f package-lock.json
47+
# Run the passed in npm command
4048
npm: docker
4149
${DOCKERRUN} \
4250
$(filter-out $@,$(MAKECMDGOALS))

0 commit comments

Comments
 (0)