Skip to main content

A construct that encapsulates different building methods, e.g. for Node, Rust, Docker.

Project description

CDKTF Local Build Construct

A simple construct that runs builds for different languages locally. Currently, it supports: docker. I plan on adding rust (cargo) and node (npm) support as well.

Usage

import { Provider, DockerBuild, DockerizedBuild } from "cdktf-local-build";

// Local Build extends LocalExec which extends from the null provider,
// so if you already have the provider initialized you can skip this step
new Provider(this, "local-build");

new DockerBuild(this, "docker-backend", {
  cwd: "/path/to/project/backend",
  dockerfile: "Dockerfile.backend",
  image: "cdktf/backend:latest",
  push: false, // defaults to true
});

new DockerizedBuild(this, "my-go-backend", {
  cwd: "/path/to/project/backend",
  command: "go build -o /tmp/backend",
  imageHomeDirectory: "/tmp/backend",
  platform: "linux/arm64",
  image: "go-builder-image:latest",
  setUser: true,
});

DockerBuild

Builds a docker image locally.

Options

  • cwd: The working directory to run the command in.
  • dockerfile: The Dockerfile to use.
  • image: The tag to use for the image.
  • push: If true, docker push <tag> is executed after the run.

DockerizedBuild

Build an artifact inside a docker image.

Options

  • cwd: The working directory to run the command in.
  • command: Build command to run int the docker image.
  • image: The tag to use for the building image.
  • imageHomeDirectory: The home directory to use inside the image.
  • platform: The platform to build for (sets docker platform flag).
  • setUser: If true, the user will be set to the current user inside docker.

CrossBuild

Builds a rust binary using cross (cross runs it inside a docker container). Please make sure cross is installed on the host machine by running cargo install cross.

Options

  • arch: The architecture to build for (arm or x86).
  • projectName: The name specified in the Cargo.toml.
  • cwd: The working directory to run the command in.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdktf-local-build-0.0.102.tar.gz (56.2 kB view details)

Uploaded Source

Built Distribution

cdktf_local_build-0.0.102-py3-none-any.whl (54.7 kB view details)

Uploaded Python 3

File details

Details for the file cdktf-local-build-0.0.102.tar.gz.

File metadata

  • Download URL: cdktf-local-build-0.0.102.tar.gz
  • Upload date:
  • Size: 56.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for cdktf-local-build-0.0.102.tar.gz
Algorithm Hash digest
SHA256 2d0e90af01d450cfbebc1034a052f300343a7c01fdb564c6998392cec4056565
MD5 5b2d4c8adc5817539340312877cf9e67
BLAKE2b-256 12174147810c323f7a9bf34f7fa4b2db019da021906db0669b6f177371abe076

See more details on using hashes here.

File details

Details for the file cdktf_local_build-0.0.102-py3-none-any.whl.

File metadata

File hashes

Hashes for cdktf_local_build-0.0.102-py3-none-any.whl
Algorithm Hash digest
SHA256 095a488287b83d517af7d47d9d67d3b7841d2893f3d7a52680803b85ca001af9
MD5 5e123492fd03d56192475ef727538789
BLAKE2b-256 566d9cd23265a14755f29c872f422ffde2aa8450438ebe3ac2aaa34da59cecbc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page