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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cdktf-local-build-0.0.100.tar.gz
  • Upload date:
  • Size: 56.1 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.100.tar.gz
Algorithm Hash digest
SHA256 d8789f220a984b7a3c5d2e7801b77e7af919dd7df0d1b412aaa3945a9948e02a
MD5 3744c73b678e5edefb79ca8b81763586
BLAKE2b-256 2d0c7fb8f80f90c35bc3fd810f1a828947283ca37b291206bd7b590ce5978a2f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cdktf_local_build-0.0.100-py3-none-any.whl
Algorithm Hash digest
SHA256 570072aedf31a1f766c0896cbb0a39e2b96ab18cfb5c425ea43b1b0fed1a75c8
MD5 40d7d1b692a88cf0ff30dc41992c0132
BLAKE2b-256 795e47adbe15a925b9152a1bf2cff7b9a0a15073a8d88052e8474e3774d5b069

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