Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osl-incubator/makim
Make Improved
https://github.com/osl-incubator/makim
automation devops task-runner tasks
Last synced: 1 day ago
JSON representation
Make Improved
- Host: GitHub
- URL: https://github.com/osl-incubator/makim
- Owner: osl-incubator
- License: bsd-3-clause
- Created: 2023-01-22T15:13:15.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-04T21:08:00.000Z (12 days ago)
- Last Synced: 2024-11-04T22:19:30.437Z (12 days ago)
- Topics: automation, devops, task-runner, tasks
- Language: Python
- Homepage: https://osl-incubator.github.io/makim/
- Size: 2.6 MB
- Stars: 8
- Watchers: 4
- Forks: 10
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Get Started
`Makim` (or `makim`) is based on `make` and focus on improve the way to define
tasks and dependencies. Instead of using the `Makefile` format, it uses `yaml`
format.
The idea of this project is to offer a way to define tasks and dependencies with
some control options, like conditionals `if`.
It allows a very easy way to define texts for documentation and extra parameters
for each task.
- License: BSD 3 Clause
- Documentation: https://osl-incubator.github.io/makim
## Features
- Help text as first-class in the `.makim.yaml` specification. It can be used by
tasks and arguments.
- Tasks have an option for arguments.
- Tasks have an option for dependencies.
- Dependencies can call a task with specific arguments.
- Dependencies can have a conditional control flow (`if`).
- Allow the creation of groups, so the tasks can be organized by topics.
- Tasks and groups have an option for user defined variables and/or environment
variables.
- Access arguments, variables or environment variables via template (using
Jinja2).
- Option for using dot environment files using `env-file` key.
## How to use it
First you need to place the config file `.makim.yaml` in the root of your
project. This is an example of a configuration file:
```yaml
version: 1.0.0
groups:
default:
env-file: .env
tasks:
clean:
help: Use this task to clean up temporary files
args:
all:
type: bool
action: store_true
help: Remove all files that are tracked by git
run: |
echo "remove file X"
build:
help: Build the program
args:
clean:
type: bool
action: store_true
help: if not set, the clean dependency will not be triggered.
dependencies:
- task: clean
if: {% raw %}${{ args.clean == true }}{% endraw %}
run: |
echo "build file x"
echo "build file y"
echo "build file z"
```
Some examples of how to use it:
- run the `build` task: `makim build`
- run the `clean` task: `makim clean`
- run the `build` task with the `clean` flag: `makim build --clean`
The help menu for the `.makim.yaml` file would looks like this:
```
$ makim --help
usage: MakIm [--help] [--version] [--config-file MAKIM_FILE] [task]
MakIm is a tool that helps you to organize and simplify your helper commands.
positional arguments:
task
Specify the task command to be performed. Options are:
default:
--------
default.clean => Use this task to clean up temporary files
ARGS:
--all: (bool) Remove all files that are tracked by git
default.build => Build the program
ARGS:
--clean: (bool) if not set, the clean dependency will not be triggered.
options:
--help, -h
Show the help menu
--version
Show the version of the installed MakIm tool.
--config-file MAKIM_FILE
Specify a custom location for the config file.
If you have any problem, open an issue at: https://github.com/osl-incubator/makim
```
As you can see, the help menu automatically adds information defined by all the
`help` key, inside the `.makim.yaml` file.