Makefile

Author: othillo

.travis.yml

@@ -9,8 +9,12 @@ matrix:
     - php: 7.3
     - php: 7.4
 
-before_script:
-    - composer install --dev
-    - cp .env.dist .env
+install:
+  - cp .env.dist .env
+  - make dependencies
 
-script: ./vendor/bin/phpunit
+script:
+  - make test
+  - make qa
+  - make license
+  - make changelog

Makefile

@@ -0,0 +1,32 @@
+.DEFAULT_GOAL:=help
+
+.PHONY: dependencies
+dependencies:
+	composer install --no-interaction --no-suggest --no-scripts --ansi
+
+.PHONY: test
+test:
+	vendor/bin/phpunit --testdox --exclude-group=none --colors=always
+
+.PHONY: qa
+qa: php-cs-fixer phpstan
+
+.PHONY: php-cs-fixer
+php-cs-fixer:
+	vendor/bin/php-cs-fixer fix --no-interaction --allow-risky=yes --diff --verbose
+
+PHONY: phpstan
+phpstan:
+	vendor/bin/phpstan analyse --level=max app/ web/
+
+.PHONY: changelog
+changelog:
+	git log $$(git describe --abbrev=0 --tags)...HEAD --no-merges --pretty=format:"* [%h](http://github.com/${TRAVIS_REPO_SLUG}/commit/%H) %s (%cN)"
+
+.PHONY: license
+license:
+	vendor/bin/docheader check --no-interaction --ansi -vvv {app,test,web}
+
+# Based on https://suva.sh/posts/well-documented-makefiles/
+help:  ## Display this help
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n\nTargets:\n"} /^[a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-20s\033[0m %s\n", $$1, $$2 }' $(MAKEFILE_LIST)

README.md

@@ -16,7 +16,7 @@ Read our blog post series about this repository at:
 Install the dependencies with composer:
 
 ```
-$ composer install
+make dependencies
 ```
 
 Configuration is determined based on environment variables. Copy `.env.dist` to `.env` and adjust where needed. 
@@ -30,8 +30,8 @@ The environment variable `TOGGLE__ALLOWED_ORIGINS` should be valid JSON. This is
 We use PHPUnit, so to run the tests simply run:
 
 ```
-$ docker-compose up -d
-$ vendor/bin/phpunit
+docker-compose up -d
+make test
 ```
 
 ## Running the app