lwupdater

README

Lacework Updater

A Go library to check for available updates of Lacework projects.

Usage

Download the library into your $GOPATH:

$ go get github.com/lacework/go-sdk/lwupdater

Import the library into your tool:

import "github.com/lacework/go-sdk/lwupdater"

Examples

This example checks for the latest release of this repository (https://github.com/lacework/go-sdk):

package main

import (
	"fmt"
	"os"

	"github.com/lacework/go-sdk/lwupdater"
)

func main() {
	var (
		project  = "go-sdk"
		sdk, err = lwupdater.Check(project, "v0.1.0")
	)

	if err != nil {
		fmt.Println("Unable to check for updates: %s", err)
		os.Exit(1)
	}

	// Output: The latest release of the go-sdk project is v0.1.7
	fmt.Printf("The latest release of the %s project is %s\n",
		project, sdk.LatestVersion,
	)
}

Look at the examples/ folder for more examples.

Documentation

Index

• Constants
• type Version
  • func Check(project, current string) (*Version, error)
  • func LoadCache(path string) (*Version, error)
  • func (cache *Version) StoreCache(path string) error

Constants

const (
	// GithubOrganization is the default Github organization where
	// Lacework stores their open source projects
	GithubOrganization = "lacework"

	// DisableEnv controls the overall check for updates behavior, when
	// this environment variable is set, we do not check for updates
	DisableEnv = "LW_UPDATES_DISABLE"
)

Types

type Version

type Version struct {
	Project        string    `json:"project"`
	CurrentVersion string    `json:"current_version"`
	LatestVersion  string    `json:"latest_version"`
	LastCheckTime  time.Time `json:"last_check_time"`
	Outdated       bool      `json:"outdated"`
}

Version is used to check project versions and store it into a cache file normally at the directory ~/.config/lacework, to execute regular version checks

func Check

func Check(project, current string) (*Version, error)

Check verifies if the a project is outdated based of the current version

func LoadCache

func LoadCache(path string) (*Version, error)

LoadCache loads a version cache file from the provided path

func (*Version) StoreCache

func (cache *Version) StoreCache(path string) error

StoreCache stores version information into the provided path