remove include: feature

docs/apko_file.md

@@ -208,9 +208,6 @@ The `paths` element contains the following children:
  - `permissions`: file permissions to set. Permissions should be specified in octal e.g. 0o755 (see `man chmod` for details).
  - `source`: used in `hardlink` and `symlink`, this represents the path to link to.
 
-
-### Includes
-
 `include` defines a path to a configuration file which should be used as the base configuration,
 the configuration data is layered on top of this base configuration.  By default, there is no
 base configuration used.

go.mod

@@ -10,7 +10,6 @@ require (
 	github.com/google/go-containerregistry v0.16.1
 	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510
 	github.com/invopop/jsonschema v0.12.0
-	github.com/jinzhu/copier v0.4.0
 	github.com/klauspost/pgzip v1.2.6
 	github.com/package-url/packageurl-go v0.1.2
 	github.com/sigstore/cosign/v2 v2.2.1

go.sum

@@ -176,8 +176,6 @@ github.com/invopop/jsonschema v0.12.0 h1:6ovsNSuvn9wEQVOyc72aycBMVQFKz7cPdMJn10C
 github.com/invopop/jsonschema v0.12.0/go.mod h1:ffZ5Km5SWWRAIN6wbDXItl95euhFz2uON45H2qjYt+0=
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
-github.com/jinzhu/copier v0.4.0 h1:w3ciUoD19shMCRargcpm0cm91ytaBhDvuRpz1ODO/U8=
-github.com/jinzhu/copier v0.4.0/go.mod h1:DfbEm0FYsaqBcKcFuvmOZb218JkPGtvSHsKg8S8hyyg=
 github.com/jmhodges/clock v1.2.0 h1:eq4kys+NI0PLngzaHEe7AmPT90XMGIEySD1JfV1PDIs=
 github.com/jmhodges/clock v1.2.0/go.mod h1:qKjhA7x7u/lQpPB1XAqX1b1lCI/w3/fNuYpI/ZjLynI=
 github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg=

pkg/build/options.go

@@ -32,7 +32,7 @@ func WithConfig(configFile string) Option {
 		bc.o.Log.Printf("loading config file: %s", configFile)
 
 		var ic types.ImageConfiguration
-		if err := ic.Load(configFile, bc.Logger()); err != nil {
+		if err := ic.Load(configFile); err != nil {
 			return fmt.Errorf("failed to load image configuration: %w", err)
 		}
 

pkg/build/types/image_configuration.go

@@ -19,10 +19,8 @@ import (
 	"os"
 	"strings"
 
-	"github.com/jinzhu/copier"
 	"gopkg.in/yaml.v3"
 
-	"chainguard.dev/apko/pkg/fetch"
 	"chainguard.dev/apko/pkg/log"
 	"chainguard.dev/apko/pkg/vcs"
 )
@@ -42,51 +40,11 @@ func (ic *ImageConfiguration) ProbeVCSUrl(imageConfigPath string, logger log.Log
 }
 
 // Parse a configuration blob into an ImageConfiguration struct.
-func (ic *ImageConfiguration) parse(configData []byte, logger log.Logger) error {
+func (ic *ImageConfiguration) parse(configData []byte) error {
 	if err := yaml.Unmarshal(configData, ic); err != nil {
 		return fmt.Errorf("failed to parse image configuration: %w", err)
 	}
 
-	if ic.Include != "" {
-		logger.Printf("including %s for configuration", ic.Include)
-
-		baseIc := ImageConfiguration{}
-
-		if err := baseIc.Load(ic.Include, logger); err != nil {
-			return fmt.Errorf("failed to read include file: %w", err)
-		}
-
-		mergedIc := ImageConfiguration{}
-
-		// Copy the base configuration...
-		if err := copier.Copy(&mergedIc, &baseIc); err != nil {
-			return fmt.Errorf("failed to copy base configuration: %w", err)
-		}
-
-		// ... and then overlay the local configuration on top.
-		if err := copier.CopyWithOption(&mergedIc, ic, copier.Option{IgnoreEmpty: true}); err != nil {
-			return fmt.Errorf("failed to overlay specific configuration: %w", err)
-		}
-
-		// Now copy the merged configuration back to ic.
-		if err := copier.Copy(ic, &mergedIc); err != nil {
-			return fmt.Errorf("failed to copy merged configuration: %w", err)
-		}
-
-		// Merge packages, repositories and keyrings.
-		keyring := append([]string{}, baseIc.Contents.Keyring...)
-		keyring = append(keyring, mergedIc.Contents.Keyring...)
-		ic.Contents.Keyring = keyring
-
-		repos := append([]string{}, baseIc.Contents.Repositories...)
-		repos = append(repos, mergedIc.Contents.Repositories...)
-		ic.Contents.Repositories = repos
-
-		pkgs := append([]string{}, baseIc.Contents.Packages...)
-		pkgs = append(pkgs, mergedIc.Contents.Packages...)
-		ic.Contents.Packages = pkgs
-	}
-
 	repos := make([]string, 0, len(ic.Contents.Repositories))
 	for _, repo := range ic.Contents.Repositories {
 		repo = strings.TrimRight(repo, "/")
@@ -97,34 +55,14 @@ func (ic *ImageConfiguration) parse(configData []byte, logger log.Logger) error
 	return nil
 }
 
-func (ic *ImageConfiguration) maybeLoadRemote(imageConfigPath string, logger log.Logger) error {
-	data, err := fetch.Fetch(imageConfigPath)
-	if err != nil {
-		return fmt.Errorf("unable to fetch remote include from git: %w", err)
-	}
-
-	return ic.parse(data, logger)
-}
-
 // Loads an image configuration given a configuration file path.
-func (ic *ImageConfiguration) Load(imageConfigPath string, logger log.Logger) error {
+func (ic *ImageConfiguration) Load(imageConfigPath string) error {
 	data, err := os.ReadFile(imageConfigPath)
 	if err != nil {
-		logger.Warnf("loading config file failed: %v", err)
-		logger.Warnf("attempting to load remote configuration")
-		logger.Warnf("NOTE: remote configurations are an experimental feature and subject to change.")
-
-		if err := ic.maybeLoadRemote(imageConfigPath, logger); err == nil {
-			return nil
-		} else {
-			// At this point, we're doing a remote config file.
-			logger.Warnf("loading remote configuration failed: %v", err)
-		}
-
 		return err
 	}
 
-	return ic.parse(data, logger)
+	return ic.parse(data)
 }
 
 // Do preflight checks and mutations on an image configuration.

pkg/build/types/schema.json

@@ -164,10 +164,6 @@
           "type": "object",
           "description": "Optional: Annotations to apply to the images manifests"
         },
-        "include": {
-          "type": "string",
-          "description": "Optional: Path to a local file containing additional image configuration\n\nThe included configuration is deep merged with the parent configuration"
-        },
         "options": {
           "additionalProperties": {
             "$ref": "#/$defs/BuildOption"

pkg/build/types/types.go

@@ -136,10 +136,7 @@ type ImageConfiguration struct {
 	VCSUrl string `json:"vcs-url,omitempty" yaml:"vcs-url,omitempty"`
 	// Optional: Annotations to apply to the images manifests
 	Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty"`
-	// Optional: Path to a local file containing additional image configuration
-	//
-	// The included configuration is deep merged with the parent configuration
-	Include string `json:"include,omitempty" yaml:"include,omitempty"`
+
 	// Optional: A map of named build option deviations
 	//
 	// Deprecated: Use WithExtraPackages.