gotaskr

Introduction

gotaskr (Go-Task-Runner) is a generic task runner which is invoked via CLI.

The tasks are written in plan Go and can easily be called from the CLI. This is especially usefull for tasks in the CI.

The tasks can be chained and in the end, there is a statistic about the tasks that were executed and their runtime.

There are some inbuilt helpers for often used things for various DevOps tasks.

Features

Compilable or directly runnable with go run
Tasks are written in plain Go and everything from Go can be used
Small footprint and easily extendable
Fanzy statistics after the execution
Custom Arguments which are named (non-positional) and can be optional
Chainable tasks
Setup and Teardown methods
Output from subprocesses directly visible
Inbuilt helpers for various DevOps tasks
VSCode Plugin to easily run tasks with a single click
Even works in existing go repositories (see build from this repository as an example)

Visual Studio Code Extension

gotaskr has a corresponding Visual Studio Code extension that allows easily running or even debugging tasks directly from Visual Studio Code. It also allows to add arguments when running or debugging them.

Example:

See https://marketplace.visualstudio.com/items?itemName=Roemer.gotaskr-vscode for details.

Quick-Start

Create a new go project:

go mod init my-project

Add gotaskr:

go get github.com/roemer/gotaskr

Create a build.go file:

package main

import (
	"os"

	"github.com/roemer/gotaskr"
)

func main() {
	os.Exit(gotaskr.Execute())
}

Now you need to register your tasks you want to be able to run:

func init() {
	gotaskr.Task("My-Task", func() error {
		fmt.Println("Hello from My-Task")
		return nil
	})
}

Now invoke this task by running:

go run . --target My-Task

Enjoy the fancy output and statistics:

------------------------------------------------------------
Running gotaskr
------------------------------------------------------------

=== My-Task ================================================
Hello from My-Task
=== /My-Task ===============================================
Duration: 00:00:00.000530

------------------------------------------------------------
Finished gotaskr at 2023-03-03 10:37:34.496
------------------------------------------------------------

Task                                              Exit Code    Duration
--------------------------------------------------------------------------------
My-Task                                           0            00:00:00.000530
--------------------------------------------------------------------------------
Total                                                          00:00:00.000530

Examples

Have a look at the examples from this repository.

Documentation

Have a look at the wiki for additional information.

mybigman / gotaskr