mage

Documentation

Index

• func Clean()
• func Deploy()
• func Doc()
• func Fmt()
• func Setup()
• func Teardown()
• type Build
  • func (b Build) API()
  • func (b Build) Cfn()
  • func (b Build) Lambda()
  • func (b Build) Tools()
• type Glue
  • func (t Glue) Sync()
• type Master
  • func (Master) Deploy()
  • func (Master) Publish()
• type Test
  • func (Test) CI()
  • func (t Test) Integration()

Functions

func Clean

func Clean()

Clean Remove dev libraries and build/test artifacts

func Deploy

func Deploy()

Deploy Deploy Panther to your AWS account

func Doc

func Doc()

Auto-generate specific sections of documentation

func Fmt

func Fmt()

Fmt Format source files

func Setup

func Setup()

Setup Install all build and development dependencies

func Teardown

func Teardown()

Teardown Destroy all Panther infrastructure

Types

type Build

type Build mg.Namespace

Build contains targets for compiling source code.

func (Build) API

func (b Build) API()

API Generate API source files from GraphQL + Swagger

func (Build) Cfn

func (b Build) Cfn()

Generate CloudFormation templates in out/deployments folder

func (Build) Lambda

func (b Build) Lambda()

Lambda Compile Go Lambda function source

func (Build) Tools

func (b Build) Tools()

Tools Compile devtools and opstools

type Glue

type Glue mg.Namespace

targets for managing Glue tables

func (Glue) Sync

func (t Glue) Sync()

Sync Sync glue table partitions after schema change

type Master

type Master mg.Namespace

func (Master) Deploy

func (Master) Deploy()

Deploy Deploy single master template (deployments/master.yml) nesting all other stacks

func (Master) Publish

func (Master) Publish()

Publish Publish a new Panther release (Panther team only)

type Test

type Test mg.Namespace

Test contains targets for testing code syntax, style, and correctness.

func (Test) CI

func (Test) CI()

CI Run all required checks for a pull request

func (Test) Integration

func (t Test) Integration()

Integration Run integration tests (integration_test.go,integration.py)