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
orx86
).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.28.tar.gz
(55.8 kB
view details)
Built Distribution
File details
Details for the file cdktf-local-build-0.0.28.tar.gz
.
File metadata
- Download URL: cdktf-local-build-0.0.28.tar.gz
- Upload date:
- Size: 55.8 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.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c69e3f02c0c01cc8f95d6b088c210ded551a1e9afe4b117a9387fd0d425bec5f |
|
MD5 | 534fa048e301d0e8671a34984c6b94fb |
|
BLAKE2b-256 | e96ae5fa06aba04385c6bf6b10a0f0cdc003a8dfb569b1b17da494e34a8e56f5 |
File details
Details for the file cdktf_local_build-0.0.28-py3-none-any.whl
.
File metadata
- Download URL: cdktf_local_build-0.0.28-py3-none-any.whl
- Upload date:
- Size: 54.2 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.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06d8c0c4741862ace9017b99fff0a5abae3da4873c985a2e2d99a965d001a605 |
|
MD5 | 2f1312ec5e3a6a1f8e4f02a842d2a894 |
|
BLAKE2b-256 | 37e645fc945902df9c6f3e2d58da0f2a9ae78a720754d3b278830cecffd48651 |