Download the main Makefile using the following, where makefiles is the destination folder in your project where
all contexts will be:
curl https://raw.githubusercontent.com/jvortmann/make-contexts/main/contexts/Makefile -o makefiles/Makefile --create-dirs
Then run make -C makefiles setup_makefile to symlink it to your project root.
make help will list all available tasks of the main Makefile to setup and update it and also to setup the contexts.
make (default) or make contexts_help will list all available contexts' help.
Contexts can be setup locally using make setup_context/{context}.
Examples: make setup_context/todo or make setup_context/test/unit/ruby.
These are the available contexts:
| Context | Description | Setup |
|---|---|---|
| gem | Tasks for managing gem release lifecycle | make setup_context/gem |
| git | Tasks for git when using tagged commit messages like in Karma | make setup_context/git |
| lint | Tasks for lint all available languages | make setup_context/lint |
| lint/elixir | Tasks for lint elixir | make setup_context/lint/elixir |
| lint/javascript | Tasks for lint javascript | make setup_context/lint/javascript |
| lint/ruby | Tasks for lint ruby | make setup_context/lint/ruby |
| test | Tasks run both unit and acceptance tests | make setup_context/test |
| test/unit | Tasks run unit tests for all available languages | make setup_context/test/unit |
| test/unit/elixir | Tasks run unit tests for elixir | make setup_context/test/unit/elixir |
| test/unit/javascript | Tasks run unit tests for javascript | make setup_context/test/unit/javascript |
| test/unit/ruby | Tasks run unit tests for ruby | make setup_context/test/unit/ruby |
| test/acceptance | Tasks for run acceptance tests (cucumber) | make setup_context/test/acceptance |
| audit | Tasks for audit all available languages | make setup_context/audit |
| audit/ruby | Tasks for audit ruby | make setup_context/audit/ruby |
| todo | Tasks for searching for TODO in the project | make setup_context/git |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
Any Makefile that lives inside the contexts folder following the same structure, help and description messages should
be displayed as available when the following is added to the top of the file (adapted to location):
-include ../prerequisites/tasks.mk
Therefore, you can create your own Makefiles and run them with the same infrastructure.
The following comment can be used to set the description/purpose of the context.
##>> This define the description/purpose of the Makefile
The following comment can be used to explain a task.
## {task_name}: {text to explaing what the task do}