Skip to content

Latest commit

 

History

History
106 lines (69 loc) · 2.98 KB

README.md

File metadata and controls

106 lines (69 loc) · 2.98 KB
Raw

druidfi/tools

Tests

Set of tools meant for ease the development.

Features

  • Generalized Make commands (build, up, down, etc)
  • Same command can be run on Docker container and on host
  • Extendable in your project
  • Easily Updatable

How to use in the project

Download oneliner (source is update.sh):

bash -c "$(curl -fsSL -H 'Cache-Control: no-cache' https://git.io/JP10q)"

Project specific

Makefiles: you can add project specific Make files to tools/make/project.

See the example below to see how they are loaded with:

-include $(PROJECT_DIR)/tools/make/project/*.mk.

Override variables

You can also add tools/make/override.mk to override variables.

For example if you want to force certain CLI values for your local setup even if something is autodetected:

# Custom Docker CLI container
CLI_SERVICE := app
CLI_USER := druid
DOCKER_PROJECT_ROOT := /app

Default commands

Command Description
make build Build for dev env
make build ENV=production Build for specified env
make debug Show debug information
make down Tear down the environment
make help List all make commands
make shell Login to CLI container
make self-update Self-update all the tools from druidfi/tools. See update.sh.
make up Launch the environment

Example on Makefile in your project root

PHONY :=
PROJECT_DIR := $(dir $(lastword $(MAKEFILE_LIST)))

# Include project env vars (if exists)
-include .env

# Include druidfi/tools config
include $(PROJECT_DIR)/tools/make/Makefile

# Include project specific make files (if they exist)
-include $(PROJECT_DIR)/tools/make/project/*.mk

.PHONY: $(PHONY)

Update the tools

Update general tools by downloading new versions of the files:

make self-update

Where this is used

FAQ

Why cannot the makefiles be included with Composer and from vendor/druidfi/tools/make?

As one of the operations make clean will remove the vendor folder.

Developing

Set Git hook. This will run tests pre-commit and if all is good, then update version.

ln -sf ../../hooks/pre-commit .git/hooks/pre-commit

Run tests:

make test

Read more about testing here.