Import

ℹ️

Introduced in Togomak v1.3.0

The import block allows you to merge multiple pipelines together, into a flatter pipeline. import blocks are evaluated before the dependency tree is generated, and hence, variables or expressions are not permitted. If you need to statisfy a more dynamic evaluation, use macro instead.

import block accepts a single parameter without any id. The block specifies the source, which should be a constant value, and could be a local file,

Example usage

For the following file structure,

togomak.hcl

togomak.hcl
- togomak.hcl

togomak.hcl

togomak {
  version = 2
}
 
import {
  source = "./module"
}
 
stage "main" {
  script = "echo script from the main file"
}
 
import {
  source = "git::https://github.com/srevinsaju/togomak-first-module"
}

module/togomak.hcl

togomak {
  version = 2
}
 
stage "another_stage" {
  script = "echo this is coming from module"
}
 
import {
  source = "./child"
}

module/child/togomak.hcl

togomak {
  version = 2
}
stage "child" {
  script = "echo hello world from the child module"
}

Argument reference

source - URL to fetch the pipeline from, could be local file path, relative file path, absolute file path, a Git URL, a HTTP URL, GCS bucket, AWS s3 bucket or mercurial.

The URL for source may be link to the required pipeline inclusive of the protocol, or you may omit in certain cases, where detectors would be run on top of it.

For example:

github.com/srevinsaju/togomak would automatically evaluate to a SSH URL
./file.hcl would evaluate a relative file in the Togomak current working directory.
git::https://github.com/srevinsaju/togomak//examples/docker would specifically checkout the examples/docker folder from the GitHub repository https://github.com/srevinsaju/togomak.git over https using git.

Additionally, you may add query strings like ?ref=abcdefg to checkout a specific commit of the repository. Check out the documentation of the underlying library, go-getter which powers terraform modules here: hashicorp/go-getter (opens in a new tab)