#349 - Development tooling and repository files

.docker/php/Dockerfile

@@ -18,6 +18,13 @@ RUN apk update && apk add \
 RUN ln -s /usr/share/zoneinfo/Europe/Paris /etc/localtime \
     && sed -i "s/^;date.timezone =.*/date.timezone = Europe\/Paris/" $PHP_INI_DIR/php.ini
 
+# pcov, to measure the coverage as the CI (built from its tarball: PECL downloads are unreliable)
+RUN apk add --no-cache --virtual .build-deps $PHPIZE_DEPS linux-headers \
+    && curl -sSL https://github.com/krakjoe/pcov/archive/refs/tags/v1.0.12.tar.gz | tar xz -C /tmp \
+    && cd /tmp/pcov-1.0.12 && phpize && ./configure && make -j"$(nproc)" && make install \
+    && docker-php-ext-enable pcov \
+    && cd / && rm -rf /tmp/pcov-1.0.12 && apk del .build-deps
+
 COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
 
 RUN usermod -u $UID www-data \

.gitattributes

@@ -1,5 +1,4 @@
 /.docker export-ignore
-/.env.dist export-ignore
 /.gitattributes export-ignore
 /.github export-ignore
 /.gitignore export-ignore

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +1,8 @@
 blank_issues_enabled: true
+contact_links:
+  - name: Security vulnerability
+    url: https://github.com/cleverage/process-bundle/security/advisories/new
+    about: Report a security vulnerability privately, never in a public issue.
+  - name: Documentation
+    url: https://github.com/cleverage/process-bundle/blob/main/docs/index.md
+    about: How to install and use the bundle.

.gitignore

@@ -1,12 +1,10 @@
 /composer.lock
 /vendor
-/vendor-sf3
-/vendor-sf4
-/vendor-sf5
 .env
 .idea
 /phpunit.xml
 .phpunit.result.cache
 .phpunit.cache
 .php-cs-fixer.cache
-coverage-report
+/.php-cs-fixer.php
+coverage-report

.php-cs-fixer.dist.php

@@ -27,7 +27,7 @@
 return (new PhpCsFixer\Config())
     ->setRules([
         '@PHP8x2Migration' => true,
-        '@PHPUnit7x5Migration:risky' => true,
+        '@PHPUnit10x0Migration:risky' => true,
         '@Symfony' => true,
         '@Symfony:risky' => true,
         'protected_to_private' => false,

CONTRIBUTING.md

@@ -50,11 +50,13 @@ configured accordingly.
 
 ## Deprecations notices
 
-When a feature should be deprecated, or when you have a breaking change for a future version, please :
+When a feature should be deprecated, or when you have a breaking change for a future version, please:
 * [Fill an issue](https://github.com/cleverage/process-bundle/issues/new)
-* Add TODO comments with the following format: `@TODO deprecated v4.0`
-* Trigger a deprecation error: `@trigger_error('This feature will be deprecated in v4.0', E_USER_DEPRECATED);`
+* Trigger a deprecation notice with `trigger_deprecation('cleverage/process-bundle', '<version>', '...')`
+  (`symfony/deprecation-contracts`), `<version>` being the next minor version, and add a `@deprecated` tag stating
+  the version of the removal (the next major version)
+* Describe the deprecation in the CHANGELOG and in `UPGRADE.md`
 
-You can check which deprecation notice is triggered in tests
+The tests fail on any deprecation notice (`failOnDeprecation` in `phpunit.xml.dist`):
 * `make bash`
-* `SYMFONY_DEPRECATIONS_HELPER=0 ./vendor/bin/phpunit`
+* `vendor/bin/phpunit`

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2015-2023 Clever-Age
+Copyright (c) Clever-Age
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -1,22 +1,24 @@
 .ONESHELL:
 SHELL := /bin/bash
 
+.PHONY: start upd up stop down build ps bash logs quality phpstan php-cs-fixer rector tests phpunit
+
 DOCKER_RUN_PHP = docker compose -f .docker/compose.yaml run --rm php "bash" "-c"
 DOCKER_COMPOSE = docker compose -f .docker/compose.yaml
 
 start: upd #[Global] Start application
 
-src/vendor: #[Composer] install dependencies
+vendor: composer.json #[Composer] Install dependencies (again when composer.json changes)
 	$(DOCKER_RUN_PHP) "composer install --no-interaction"
 
 upd: #[Docker] Start containers detached
 	touch .docker/.env
-	make src/vendor
+	$(MAKE) vendor
 	$(DOCKER_COMPOSE) up --remove-orphans --detach
 
 up: #[Docker] Start containers
 	touch .docker/.env
-	make src/vendor
+	$(MAKE) vendor
 	$(DOCKER_COMPOSE) up --remove-orphans
 
 stop: #[Docker] Down containers
@@ -31,7 +33,7 @@ build: #[Docker] Build containers
 ps: # [Docker] Show running containers
 	$(DOCKER_COMPOSE) ps
 
-bash: #[Docker] Connect to php container with current host user
+bash: upd #[Docker] Connect to php container with current host user
 	$(DOCKER_COMPOSE) exec php bash
 
 logs: #[Docker] Show logs

README.md

@@ -1,6 +1,10 @@
 CleverAge/ProcessBundle
 =======================
 
+[![Test](https://github.com/cleverage/process-bundle/actions/workflows/test.yml/badge.svg)](https://github.com/cleverage/process-bundle/actions/workflows/test.yml)
+[![Packagist Version](https://img.shields.io/packagist/v/cleverage/process-bundle)](https://packagist.org/packages/cleverage/process-bundle)
+[![License](https://img.shields.io/packagist/l/cleverage/process-bundle)](LICENSE)
+
 This bundle allows to configure series of tasks to be performed on a certain order.
 Basically, it will greatly ease the configuration of import and exports but can do much more.
 

composer.json

@@ -32,6 +32,12 @@
             "role": "Maintainer"
         }
     ],
+    "support": {
+        "issues": "https://github.com/cleverage/process-bundle/issues",
+        "source": "https://github.com/cleverage/process-bundle",
+        "docs": "https://github.com/cleverage/process-bundle/blob/main/docs/index.md",
+        "security": "https://github.com/cleverage/process-bundle/security/policy"
+    },
     "autoload": {
         "psr-4": {
             "CleverAge\\ProcessBundle\\": "src/"