build

README

Reusable Mage build tools

This package includes standard mage targets useful in the build.

See: https://magefile.org/magefiles/.

This can get added to a project using:

import (
    // mage:import
    _ "github.com/grafana/grafana-plugin-sdk-go/build"
)

https://magefile.org/importing/

Documentation

Index

• func BuildAll()
• func Clean() error
• func Coverage() error
• func Debugger() error
• func Format() error
• func Lint() error
• func ReloadPlugin() error
• func Test() error
• type Build
  • func (Build) Backend()
  • func (Build) Darwin() error
  • func (Build) Debug() error
  • func (Build) Linux() error
  • func (Build) Windows() error

Functions

func BuildAll

func BuildAll()

BuildAll builds production back-end components.

func Clean

func Clean() error

Clean cleans build artifacts, by deleting the dist directory.

func Coverage

func Coverage() error

Coverage runs backend tests and makes a coverage report.

func Debugger

func Debugger() error

Debugger makes a new debug build and attaches dlv (go-delve).

func Format

func Format() error

Format formats the sources.

func Lint

func Lint() error

Lint audits the source style

func ReloadPlugin

func ReloadPlugin() error

ReloadPlugin - kills any running instances and waits for grafana to reload the plugin

func Test

func Test() error

Test runs backend tests.

Types

type Build

type Build mg.Namespace

Build is a namespace.

func (Build) Backend

func (Build) Backend()

Backend build a production build for all platforms

func (Build) Darwin

func (Build) Darwin() error

Darwin builds the back-end plugin for OSX.

func (Build) Debug

func (Build) Debug() error

Debug builds the debug version for the current platform

func (Build) Linux

func (Build) Linux() error

Linux builds the back-end plugin for Linux.

func (Build) Windows

func (Build) Windows() error

Windows builds the back-end plugin for Windows.