bundledesc

Documentation

Overview

Package bundledesc contains definition of a "bundle description".

It is a JSON document that gets embedded into the output bundle. It describes important features of the bundle (such as the format version). It may be used for future and backward compatibility checks.

Index

• Constants
• func Modify(f *fileset.Set, cb func(desc *Description) error) error
• type Description
• type GoGAEBundle

Constants

const FormatVersion = "2024.0"

FormatVersion is embedded into the bundle.

It should be bumped whenever there are changes to the bundle structure that may require special handling from whatever is consuming the bundle (e.g. "gaedeploy" tool). Such consumers can tweak their behavior based on the format version they see in the bundle.

const Path = ".cloudbuildhelper.json"

Path is a path where the description is stored within the bundle.

Functions

func Modify

func Modify(f *fileset.Set, cb func(desc *Description) error) error

Modify reads the existing description, calls the callback to update it, and writes it back.

Creates a new empty one if necessary.

Types

type Description

type Description struct {
	// FormatVersion defines the format of the bundle.
	FormatVersion string `json:"format_version"`
	// GoGAEBundles is a list of Go GAE apps copied into the bundle.
	GoGAEBundles []GoGAEBundle `json:"go_gae_bundles,omitempty"`
}

Description gets embedded into the output bundle as a JSON file.

type GoGAEBundle

type GoGAEBundle struct {
	// AppYAML is a path to the app YAML relative to the bundle root.
	AppYAML string `json:"app_yaml"`
}

GoGAEBundle describes a Go GAE app added to the bundle.