https://github.com/desertbit/grml

A simple build automation tool written in Go
https://github.com/desertbit/grml

build build-automation buildtool

Last synced: 3 months ago
JSON representation

A simple build automation tool written in Go

• Host: GitHub
• URL: https://github.com/desertbit/grml
• Owner: desertbit
• License: gpl-3.0
• Created: 2017-02-12T11:25:20.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-07-04T22:38:14.000Z (over 1 year ago)
• Last Synced: 2024-06-21T17:55:54.666Z (5 months ago)
• Topics: build, build-automation, buildtool
• Language: Go
• Size: 78.1 KB
• Stars: 14
• Watchers: 3
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

• awesome-repositories - desertbit/grml - A simple build automation tool written in Go (Go)

README

        
# grml - A simple build automation tool written in Go

grml is a simple Makefile alternative. Build targets are defined in a `grml.yaml` file located in the project's root directory.

This file uses the [YAML](http://yaml.org/) syntax.

A minimal sample can be found within the [sample](sample/grml.yaml) directory. Enter the directory with a terminal and execute `grml`.

[![asciicast](https://asciinema.org/a/460524.svg)](https://asciinema.org/a/460524)

## Installation

### From Source

    go install github.com/desertbit/grml@latest

### Prebuild Binaries

https://github.com/desertbit/grml/releases

## Specification

- Environment variables can be defined in the **env** section. These variables are passed to all run target processes.

- Variables are also accessible with the `${}` selector within **help** messages and **import** statements.

- Dependencies can be specified within the command's **deps** section.

### Additonal Environment Variables

The process environment is inherited and following additonal variables are set:

| KEY     | VALUE                                                          |

|:--------|:---------------------------------------------------------------|

| ROOT    | Path to the root build directory containing the grml.yaml file |

| PROJECT | Project name as specified within the grml file                 |

| NUMCPU  | Number of CPU cores                                            |