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

Uploaded Source

Built Distribution

cdktf_local_build-0.0.76-py3-none-any.whl (54.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cdktf-local-build-0.0.76.tar.gz
  • Upload date:
  • Size: 56.0 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.76.tar.gz
Algorithm Hash digest
SHA256 8364d433ee1953b81f42a4d21504afc87e54103add27e7620ceb67dbefae7279
MD5 4ec3b135442f4e7024733e954142e35d
BLAKE2b-256 182d759f2c741587336806a9d35c1927af2e4c85a973f4460f259f2da98133d1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cdktf_local_build-0.0.76-py3-none-any.whl
Algorithm Hash digest
SHA256 f6b3b459c012ec26ed14a80bb9f1ad6006f3306688c1005b73e3a6296fca4945
MD5 eb05b5d65d35933ea32fe5f523da2aee
BLAKE2b-256 0e6a4fb4ad31712ad7c6f9ce163815e313eb5fa080f88b805423dd8c97d5b2ed

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