Skip to content

Commit

Permalink
add more useful standard build, add makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
maschmann committed Oct 1, 2024
1 parent 19af3a8 commit eddef82
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 8 deletions.
2 changes: 2 additions & 0 deletions .docker/Dockerfile → Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
FROM php:8.3-cli

WORKDIR /app

ENV ANSIBLE_VERSION 2.9.17

# composer
Expand Down
66 changes: 66 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Executables (local)
DOCKER_COMP = docker compose

# Docker containers
PHP_CONT = $(DOCKER_COMP) exec php-ansible

# Executables
PHP = $(PHP_CONT) php
COMPOSER = $(PHP_CONT) composer

# Misc
.DEFAULT_GOAL = help

## —— php-ansible Makefile 🎵 ——————————————————————————————————
help: ## Outputs this help screen
@grep -E '(^[a-zA-Z0-9\./_-]+:.*?##.*$$)|(^##)' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}{printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' | sed -e 's/\[32m##/[33m/'

## —— Docker 🐳 ————————————————————————————————————————————————————————————————
build: ## Builds the Docker images
@$(DOCKER_COMP) build --pull --no-cache

up: ## Start the docker hub in detached mode (no logs)
@$(DOCKER_COMP) up --detach

start: build up ## Build and start the containers

down: ## Stop the docker hub
@$(DOCKER_COMP) down --remove-orphans

logs: ## Show live logs
@$(DOCKER_COMP) logs --tail=0 --follow

sh: ## Connect to the php-fpm container
@$(PHP_CONT) sh

bash: ## Connect to the php-fpm container via bash so up and down arrows go to previous commands
@$(PHP_CONT) bash

test: ## Start tests with phpunit, pass the parameter "c=" to add options to phpunit, example: make test c="--group e2e --stop-on-failure"
@$(eval c ?=)
@$(PHP_CONT) vendor/bin/phpunit -c phpunit.xml.dist $(c)

analyze: ## Start analysis with phpstan, pass the parameter "c=" to add options to phpstan. Default config ist always used, example: make analyze c="--group e2e"
@$(eval c ?=)
@$(PHP_CONT) vendor/bin/phpstan --configuration=phpstan.neon $(c)

codestyle: ## Start codestyle analysis with phpcs, pass the parameter "c=" to add options to phpcs. Default config ist always used. Example: make codestyle c="--parallel=2"
@$(eval c ?=)
@$(PHP_CONT) vendor/bin/phpcs --standard=phpcs.xml.dist $(c)

codestyle-fix: ## Start codestyle analysis with phpcbf, pass the parameter "c=" to add options to phpcbf. Default config ist always used. Example: make codestyle c="--parallel=2"
@$(eval c ?=)
@$(PHP_CONT) vendor/bin/phpcbf --standard=phpcs.xml.dist $(c)

psalm: ## Start code analysis with psalm, pass the parameter "c=" to add options to psalm. Default config ist always used. Example: make codestyle c="--level=2"
@$(eval c ?=)
@$(DOCKER_COMP) exec -e APP_ENV=dev php vendor/bin/psalm --config=psalm.xml $(c)

## —— Composer 🧙 ——————————————————————————————————————————————————————————————
composer: ## Run composer, pass the parameter "c=" to run a given command, example: make composer c='req phpstan/phpstan'
@$(eval c ?=)
@$(COMPOSER) $(c)

vendor: ## Install vendors according to the current composer.lock file
vendor: c=install --prefer-dist --no-dev --no-progress --no-scripts --no-interaction
vendor: composer
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,11 +164,10 @@ $ansible

## Development

You can use the provided docker image with ```docker compose up``` which uses a default php-cli docker image and ansible 2.x. See the ```.docker/Dockerfile``` for more info.

Composer install: ```docker exec -u <YOUR_UID> -w /var/php-ansible -it php-ansible composer install```

You can run code or the tests within the container: ```docker exec -u <YOUR_UID> -w /var/php-ansible -it php-ansible php ./vendor/bin/phpunit --testdox```
You can use the provided docker image with ```make build``` which uses a default php-cli docker image and ansible 2.x. See the ```Dockerfile``` for more info.
Start the container with ```make up```.
Composer install: ```make vendor```
You can run code or the tests within the container: ```make test c="--testdox"```

## Thank you for your contributions!

Expand Down
4 changes: 2 additions & 2 deletions docker-compose.yml → compose.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
services:
php-ansible:
build: ./.docker
build: .
container_name: php-ansible
volumes:
- ./:/var/php-ansible
- ./:/app
2 changes: 1 addition & 1 deletion psalm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<psalm
errorLevel="2"
resolveFromConfigFile="1"
phpVersion="8.0"
phpVersion="8.3"
>
<projectFiles>
<directory name="Asm" />
Expand Down

0 comments on commit eddef82

Please sign in to comment.