appreload

Documentation

Overview

Package appreload allows to detect changes in the source code for a Go application and rebuild the executable. In case of success it can kill the previous running version, and launch the newly created executable.

Index

• type AppUpdater
  • func NewAppUpdater(conf *AppUpdaterConf, ins *obs.Insighter) *AppUpdater
  • func (a *AppUpdater) Launch()
  • func (a *AppUpdater) RebuildAndRelaunch()
  • func (a *AppUpdater) Shutdown()
  • func (a *AppUpdater) UpdateResource(e *watcher.Event)
• type AppUpdaterConf

Types

type AppUpdater

type AppUpdater struct {
	// contains filtered or unexported fields
}

AppUpdater keeps tracks of changes in an app, and updated the files automatically. It also rebuilds and relaunches the app in case source files changed.

func NewAppUpdater

func NewAppUpdater(conf *AppUpdaterConf, ins *obs.Insighter) *AppUpdater

NewAppUpdater creates a new AppUpdater struct to keep track of changes

func (*AppUpdater) Launch

func (a *AppUpdater) Launch()

Launch starts watching directories for changes, taking action for those file extensions that are listed in the build and resources list in the AppUpdaterConf

func (*AppUpdater) RebuildAndRelaunch

func (a *AppUpdater) RebuildAndRelaunch()

RebuildAndRelaunch tries to rebuild an executable, and if succesful kills old one to launch the new one.

func (*AppUpdater) Shutdown

func (a *AppUpdater) Shutdown()

Shutdown stops watching for file changes

func (*AppUpdater) UpdateResource

func (a *AppUpdater) UpdateResource(e *watcher.Event)

UpdateResource collects a new / updated resource file and puts in the bundle directory.

type AppUpdaterConf

type AppUpdaterConf struct {
	ExecDir       string
	PkgsDirs      []string
	BuildFileExts []string
	ResFileExts   []string
	BundleDir     string
}

AppUpdaterConf has the config vars to set up an AppUpdater instance:

• ExecDir: the main sources directory for the executable (is also used to generate the temp binary file name)
• PkgsDirs: the list of directories to observe for changes
• BuildFileExts: file extensions that should trigger a new binary build
• ResFilesExts: file extensions that should trigger an update of the resource files