Skip to main content

conveyor build

Build a project

Synopsis​

Build a project and release a packaged version of the code to Conveyor. After this command you can deploy it to an environment.

conveyor build [flags]

Examples​


The simplest way to run the build and also validate your dags is:
$ conveyor project build

If you want to disable dag validation while building your project:
$ conveyor project build --skip-dag-validation

If you want to use multiple build args:
$ conveyor project build --build-arg key=value --build-arg key2=value2

If you want to build and validate the DAGs of your project and your DAGs depend on a common project,
that is deployed to a different environment than specified in the dependencies section of your .conveyor/project.yaml (e.g. dev).
For more details look at: https://docs.conveyordata.com/how-to-guides/working-with-airflow/common-project-with-airflow-utilities.
$ conveyor project build --project-dependencies-environment dev

It is possible to pass additional options to the container runtime directly.
For example, to build an image without using the cache, you can run:
$ conveyor project build --build-opts="--no-cache"

Options​

      --build-arg list                            Set build-time variables for the containers. Same as Docker build-arg argument
      --build-args list                           (Deprecated) Please use build-arg instead
      --build-opts string                         Pass additional options to the container runtime (format: space-separated string)
      --dag-env-var list                          Set environment variable used for DAG validation or generation
      --dag-validation-command string             Set this if you use a custom dag validation image and want to change the command that is ran (default "dag_validation")
      --dag-validation-image string               Set this if you want to use a custom dag validation image
  -h, --help                                      help for build
      --project-dependencies-environment string   Overwrite default project dependencies environment
      --secret stringArray                        Secret file to expose to the build (only if BuildKit enabled): id=mysecret,src=/local/secret
      --skip-dag-validation                       Set to skip the Airflow DAG validation
      --ssh stringArray                           SSH agent socket or keys to expose to the build (only if BuildKit enabled) (format: default|<id>[=<socket>|<key>[,<key>]])

Options inherited from parent commands​

      --debug                        Show debug output
      --no-browser NO_BROWSER=true   Do not automatically open a browser at login instead print the url to the command line. You can also use the environment variable NO_BROWSER=true.
  -o, --output string                Change the output. Valid options are table or json (default "table")
      --quiet QUIET=true             Quiet down the output. You can also use the environment variable QUIET=true.

See also​

  • conveyor - A CLI to operate your Conveyor environments and projects