diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f84426699b9c..adf3eed48524 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,11 @@ > Please note that you need to install the "extended" version of Hugo (with > built-in support) to run the site locally. +A few notes to be aware of: + +* Before submitting a PR be sure to run `make test` and address any issues uncovered +* Any make target that requires `get-milestones` requires that a GH_TOKEN environment variable be set + ## Deploy previews Whenever you submit a pull request to this repo, Netlify creates a [deploy diff --git a/Makefile b/Makefile index 87bd73da0781..b014ac46c058 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,15 @@ +build: + hugo --minify + +ci-build-preview: + hugo \ + --baseURL $(DEPLOY_PRIME_URL) \ + --minify + +ci-link-check: + curl https://raw.githubusercontent.com/wjdp/htmltest/master/godownloader.sh | bash + bin/htmltest + clean: rm -rf public @@ -9,27 +21,11 @@ setup: serve: setup hugo server -p 30000 --buildDrafts --buildFuture && npm start -preview-build: get-milestones - hugo \ - --baseURL $(DEPLOY_PRIME_URL) \ - --minify - make ci-link-check +test: build ci-link-check -production-build: get-milestones - hugo \ - --minify - make ci-link-check +preview-build: get-milestones ci-build-preview ci-link-check + +production-build: get-milestones build ci-link-check get-milestones: setup node -r esm ./scripts/fetchMilestones.js - -build: - hugo --minify - -link-checker-setup: - curl https://raw.githubusercontent.com/wjdp/htmltest/master/godownloader.sh | bash - -run-link-checker: - bin/htmltest - -ci-link-check: link-checker-setup run-link-checker