fix/few packaging fixes

[jokesterfr]

Changes summary

• Remove unecessary .gitkeep file
• Git Ignore slight review
• Lint the readme file
• Makefile
  • Reintroduce git clean
  • Differentiate SEM_VERSION from VERSION
  • Enhance output of the help command
  • Remove .PHONY on top of config.php target

Questions

Makefile: should we keep using vendor-clean when we call make?

default: bundle
bundle: php-scoper ...
php-scoper: php-scoper-add-prefix ...
php-scoper-add-prefix: vendor-clean ...
vendor-clean:
	rm -rf ./vendor

Makefile: can we rename bundle to build?

Definition of "bundle": tie or roll up (a number of things) together as though into a parcel.

I see it as a confusing name, in particular with the "zip" artefact. In fact there is a BUNDLE section with BUNDLE_ZIP. I would rather prefer to speak about "build" when you gather all deps, and bundle when you roll up them altogether, as a zip archive.

Makefile the "config.php" file is essential to make the project work. However there is no creation of such file when calling make with a cleaned project. Furthermore this seems to be used in a complex docker-only process:

.PHONY: config.php
config.php:
	@docker exec -w ${CONTAINER_INSTALL_DIR} phpunit \
		sh -c "if [ ! -f ./config.php ]; then cp ./config.dist.php ./config.php; fi"

platform-module-install: config.php ...

I guess removing the .PHONY and letting build the config file from make is a better choice. Do we need a distinct configuration file than default for a docker test?

[hschoenenberger]

That dir is not supposed to survive the scoping process

[jokesterfr]

It is "flashing" in my IDE file browser just the time the scoping starts. It's annoying to my old eyes :D

[hschoenenberger]

Makefile the "config.php" file is essential to make the project work. However there is no creation of such file when calling make with a cleaned project. Furthermore this seems to be used in a complex docker-only process:

.PHONY: config.php
config.php:
	@docker exec -w ${CONTAINER_INSTALL_DIR} phpunit \
		sh -c "if [ ! -f ./config.php ]; then cp ./config.dist.php ./config.php; fi"

platform-module-install: config.php ...

I guess removing the .PHONY and letting build the config file from make is a better choice. Do we need a distinct configuration file than default for a docker test?

Just to be clear I need to be able to build locally for local, prod, preprod etc. Maybe we can add a test config file then build explicitly with it at CI time ?

[jokesterfr]

Just to be clear I need to be able to build locally for local, prod, preprod etc. Maybe we can add a test config file then build explicitly with it at CI time ?

My point is prior to any CI consideration there should be an easy way to locally:

• build the project without any zip, ex: make
• bundle an e2e/local zip, ex: make zip-e2e
• bundle an integration zip, ex: make zip-inte
• bundle a pre-production zip, ex: make zip-preprod
• bundle a production zip, ex: make zip-prod

And a handy all-in-one command, ex: make zip, calling all the upper-mentioned commands.
Output zips will be stored in the gitignored ./dist directory.

Step 1 is building and step 2 is bundling, and the last one is optional.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud