makefile for common tasks

Author: chris48s

.github/workflows/test.yml

@@ -21,20 +21,15 @@ jobs:
         run: |
           pip install --upgrade pip
           pip install poetry
-          ./build-drafter.sh
+          make build-drafter
           poetry install
-          pip install 'Django ${{ matrix.django-version }}'
+          make install
 
       - name: Check coding standards
-        run: |
-          poetry run isort --profile black -c --diff .
-          poetry run flake8 .
-          poetry run black --check .
+        run: make lint
 
       - name: Run tests
-        run: |
-          poetry run coverage run --source=apiblueprint_view --omit=apiblueprint_view/tests/*.py ./run_tests.py
-          poetry run coverage xml
+        run: make test
 
       - name: Ensure package builds
         run: poetry build

CONTRIBUTING.md

@@ -9,8 +9,7 @@ This project uses:
 
 Development Tasks:
 
-* Install dependencies: `poetry install`
-* Run the test suite: `./run_tests.py`
-* Sort imports: `isort --profile black .`
-* Run lint checks: `flake8 .`
-* Auto-format: `black .`
+* Install dependencies: `make install`
+* Run the test suite: `make test`
+* Run lint checks: `make lint`
+* Auto-format: `make format`

Makefile

@@ -0,0 +1,23 @@
+.PHONY: help build-drafter format install lint test
+
+help:
+	@grep '^\.PHONY' Makefile | cut -d' ' -f2- | tr ' ' '\n'
+
+build-drafter:
+	./build-drafter.sh
+
+format:
+	poetry run isort --profile black .
+	poetry run black .
+
+install:
+	poetry install
+
+lint:
+	poetry run isort --profile black -c --diff .
+	poetry run black --check .
+	poetry run flake8 .
+
+test:
+	poetry run coverage run --source=apiblueprint_view --omit=apiblueprint_view/tests/*.py ./run_tests.py
+	poetry run coverage xml