Update docs and Makefile help to reference custom git hooks (#14450)

mozilla · Apr 15, 2024 · 69baed8 · 69baed8
1 parent a367117
commit 69baed8
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 26 deletions.
diff --git a/Makefile b/Makefile
@@ -8,32 +8,34 @@ all: help
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  build                      - build docker images for dev"
-	@echo "  run                        - docker-compose up the entire system for dev"
-	@echo "  stop                       - stop all docker containers"
-	@echo "  kill                       - kill all docker containers (more forceful than stop)"
-	@echo "  pull                       - pull the latest production images from Docker Hub"
-	@echo "  run-shell                  - open a bash shell in a fresh container"
-	@echo "  shell                      - open a bash shell in the running app"
-	@echo "  djshell                    - start the Django Python shell in the running app"
-	@echo "  fresh-data                 - pull the latest database and update all external data"
-	@echo "  clean                      - remove all build, test, coverage and Python artifacts"
-	@echo "  rebuild                    - force a rebuild of all of the docker images"
-	@echo "  lint                       - check style with Ruff, ESlint, Stylelint, and Prettier"
-	@echo "  format                     - format front-end code using Stylelint and Prettier"
-	@echo "  test                       - run tests against local files"
-	@echo "  test-image                 - run tests against files in docker image"
-	@echo "  test-cdn                   - run CDN tests against TEST_DOMAIN"
-	@echo "  docs                       - generate Sphinx HTML documentation with server and live reload using Docker"
-	@echo "  livedocs                   - generate Sphinx HTML documentation with server and live reload"
-	@echo "  build-docs                 - generate Sphinx HTML documentation using Docker"
-	@echo "  build-ci                   - build docker images for use in our CI pipeline"
-	@echo "  test-ci                    - run tests against files in docker image built by CI"
-	@echo "  compile-requirements       - update Python requirements files using pip-compile"
-	@echo "  check-requirements         - get a report on stale/old Python dependencies in use"
-	@echo "  install-local-python-deps  - install Python dependencies for local development"
-	@echo "  preflight  				- refresh installed dependencies and fetch latest DB ahead of local dev"
-	@echo "  clean-local-deps  			- remove all local installed Python dependencies"
+	@echo "  build                          - build docker images for dev"
+	@echo "  run                            - docker-compose up the entire system for dev"
+	@echo "  stop                           - stop all docker containers"
+	@echo "  kill                           - kill all docker containers (more forceful than stop)"
+	@echo "  pull                           - pull the latest production images from Docker Hub"
+	@echo "  run-shell                      - open a bash shell in a fresh container"
+	@echo "  shell                          - open a bash shell in the running app"
+	@echo "  djshell                        - start the Django Python shell in the running app"
+	@echo "  fresh-data                     - pull the latest database and update all external data"
+	@echo "  clean                          - remove all build, test, coverage and Python artifacts"
+	@echo "  rebuild                        - force a rebuild of all of the docker images"
+	@echo "  lint                           - check style with Ruff, ESlint, Stylelint, and Prettier"
+	@echo "  format                         - format front-end code using Stylelint and Prettier"
+	@echo "  test                           - run tests against local files"
+	@echo "  test-image                     - run tests against files in docker image"
+	@echo "  test-cdn                       - run CDN tests against TEST_DOMAIN"
+	@echo "  docs                           - generate Sphinx HTML documentation with server and live reload using Docker"
+	@echo "  livedocs                       - generate Sphinx HTML documentation with server and live reload"
+	@echo "  build-docs                     - generate Sphinx HTML documentation using Docker"
+	@echo "  build-ci                       - build docker images for use in our CI pipeline"
+	@echo "  test-ci                        - run tests against files in docker image built by CI"
+	@echo "  compile-requirements           - update Python requirements files using pip-compile"
+	@echo "  check-requirements             - get a report on stale/old Python dependencies in use"
+	@echo "  install-local-python-deps      - install Python dependencies for local development"
+	@echo "  install-custom-git-hooks       - install custom git hooks"
+	@echo "  uninstall-custom-git-hooks     - uninstall custom git hooks"
+	@echo "  clean-local-deps               - remove all local installed Python dependencies"
+	@echo "  preflight                      - refresh installed dependencies and fetch latest DB ahead of local dev"
 
 .env:
 	@if [ ! -f .env ]; then \

diff --git a/docs/install.rst b/docs/install.rst
@@ -240,6 +240,8 @@ credits, release notes, localizations, legal-docs etc::
     dependencies up to date and also fetches the latest DB containing the latest site
     content. This is a good thing to run after pulling latest changes from the ``main`` branch.
 
+    We also have a git hook that will alert you if ``make preflight`` needs to be run. You can install it with ``make install-custom-git-hooks``
+
 .. _run-python-tests:
 
 Run the tests