launchr

README

Launchr

Launchr is a CLI action runner that executes actions inside short-lived local containers.
Actions are defined in action.yaml files, which are automatically discovered in the filesystem. They can be placed anywhere that makes sense semantically. You can find action examples here and in the documentation.
Launchr has a plugin system that allows to extend its functionality. See core plugins, compose and documentation.

Table of contents

• Usage
• Installation
  • Installation from source
• Development

Usage

Build launchr from source locally. Build dependencies:

1. go >=1.20, see installation guide
2. make

Build the launchr tool:

make
bin/launchr --help

The documentation for launchr usage can be found in docs.

If you face any issues with launchr:

1. Open an issue in the repo.
2. Share the app version with launchr --version

Installation

Installation from source

Build dependencies:

1. go >=1.20, see installation guide
2. make

Global installation

Install launchr globally:

make install
launchr --version

The tool will be installed in $GOPATH/bin which is usually ~/go/bin.
If GOPATH env variable is not available, make sure you have it in ~/.bashrc or ~/.zhrc:

export GOPATH=`go env GOPATH`
export PATH=$PATH:$GOPATH/bin

Local installation

The tool can be built and run locally:

make
bin/launchr --version

Development

The launchr can be built with a make to bin directory:

make

It is also supported to make a build to use with dlv for debug:

make DEBUG=1

Useful make commands:

1. Fetch dependencies - make deps
2. Test the code - make test
3. Lint the code - make lint

Publishing a new release

1. Install goreleaser
2. Create an Access token on GitHub
3. Create a tag, build a release and push

   git tag -a v0.0.0 -m "Release notes"
   export GITHUB_TOKEN="[TOKEN]"
   goreleaser release --clean
   

Documentation

Overview

Package launchr has application implementation.

Index

• Constants
• Variables
• func EnsurePath(parts ...string) error
• func Gen() int
• func GetFsAbsPath(fs fs.FS) string
• func RegisterPlugin(p Plugin)
• func Run() int
• type ActionDiscoveryPlugin
• type App
• type AppVersion
  • func Version() *AppVersion
• type CobraPlugin
• type Config
• type ConfigAware
• type GeneratePlugin
• type ManagedFS
• type OnAppInitPlugin
• type Plugin
• type PluginGeneratedData
• type PluginInfo
• type PluginManager
• type Service
• type ServiceInfo

Constants

const (
	// PkgPath is a main module path.
	PkgPath = launchr.PkgPath
)

Variables

var ActionsGroup = &cobra.Group{
	ID:    "actions",
	Title: "Actions:",
}

ActionsGroup is a cobra command group definition

Functions

func EnsurePath

func EnsurePath(parts ...string) error

EnsurePath creates all directories in the path.

func Gen

func Gen() int

Gen generates application specific build files and returns os exit code.

func GetFsAbsPath

func GetFsAbsPath(fs fs.FS) string

GetFsAbsPath returns absolute path for an FS struct.

func RegisterPlugin

func RegisterPlugin(p Plugin)

RegisterPlugin add a plugin to global pull.

func Run

func Run() int

Run executes launchr application.

Types

type ActionDiscoveryPlugin

type ActionDiscoveryPlugin = action.DiscoveryPlugin

ActionDiscoveryPlugin is an interface to implement a plugin to discover actions.

type App

type App = launchr.App

App stores global application state.

type AppVersion

type AppVersion = launchr.AppVersion

AppVersion stores application version.

func Version

func Version() *AppVersion

Version provides app version info.

type CobraPlugin

type CobraPlugin = launchr.CobraPlugin

CobraPlugin is an interface to implement a plugin for cobra.

type Config

type Config = launchr.Config

Config handles application configuration.

type ConfigAware

type ConfigAware = launchr.ConfigAware

ConfigAware provides an interface for structs to support launchr configuration setting.

type GeneratePlugin

type GeneratePlugin = launchr.GeneratePlugin

GeneratePlugin is an interface to generate supporting files before build.

type ManagedFS

type ManagedFS = launchr.ManagedFS

ManagedFS is a File System managed by launchr.

type OnAppInitPlugin

type OnAppInitPlugin = launchr.OnAppInitPlugin

OnAppInitPlugin is an interface to implement a plugin for app initialisation.

type Plugin

type Plugin = launchr.Plugin

Plugin is a common interface for launchr plugins.

type PluginGeneratedData

type PluginGeneratedData = launchr.PluginGeneratedData

PluginGeneratedData is a struct containing a result information of plugin generation.

type PluginInfo

type PluginInfo = launchr.PluginInfo

PluginInfo provides information about the plugin and is used as a unique data to indentify a plugin.

type PluginManager

type PluginManager = launchr.PluginManager

PluginManager handles plugins.

type Service

type Service = launchr.Service

Service is a common interface for a service to register.

type ServiceInfo

type ServiceInfo = launchr.ServiceInfo

ServiceInfo provides service info for its initialization.