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.43.tar.gz (55.6 kB view details)

Uploaded Source

Built Distribution

cdktf_local_build-0.0.43-py3-none-any.whl (54.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cdktf-local-build-0.0.43.tar.gz
  • Upload date:
  • Size: 55.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for cdktf-local-build-0.0.43.tar.gz
Algorithm Hash digest
SHA256 aa2585ebe3d53bcc5208dc9c9e2c18a38f70614c1173e1c60527a341dfaa2a38
MD5 f6f8dc820a1d47b201441fabd0fc299d
BLAKE2b-256 3207e500cb2c7b2a9a00f8f6f9505a5569ed995a1b4559eeaf5e428c48b7d80a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cdktf_local_build-0.0.43-py3-none-any.whl
  • Upload date:
  • Size: 54.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for cdktf_local_build-0.0.43-py3-none-any.whl
Algorithm Hash digest
SHA256 f3140083b04ea97cf7bd5dec500e8562f394d7fa7f9d60b607d1b0087b828b84
MD5 661abf528a53d4c59cf0fe2480acc723
BLAKE2b-256 0b81606621b2b54f97838ee7ca1262bcfd934ef221439d5f57a5f0af21adec66

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