A simple construct that executes a command locally. This is useful to run build steps within your CDKTF Program or to run a post action after a resource is created.
Project description
CDKTF Local Exec Construct
A simple construct that executes a command locally. This is useful to run build steps within your CDKTF Program or to run a post action after a resource is created.
The construct uses the null provider to achieve this so it can be trusted to only run after all dependencies are met.
Usage
import { Provider, LocalExec } from "cdktf-local-exec";
// LocalExec extends from the null provider,
// so if you already have the provider initialized you can skip this step
new Provider(this, "local-exec");
const frontend = new LocalExec(this, "frontend-build", {
// Will copy this into an asset directory
cwd: "/path/to/project/frontend",
command: "npm install && npm build",
});
const pathToUpload = `${frontend.path}/dist`;
new LocalExec(this, "frontend-upload", {
cwd: pathToUpload,
command: `aws s3 cp --recursive ${pathToUpload} s3://${bucket.name}/frontend`,
});
new LocalExec(this, "backend-build", {
cwd: "/path/to/project/backend",
copyBeforeRun: false, // can not run remotely since the runner has no docker access
command: "docker build -t foo . && docker push foo",
});
Options
cwd
: The working directory to run the command in. It will be copied before execution to ensure the asset can be used in a remote execution environment.command
: The command to execute.copyBeforeRun
: If true, the command will copy thecwd
directory into a tmp dir and run there. If false, the command will be executed in thecwd
directory.
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-exec-0.2.13.tar.gz
(28.7 kB
view hashes)
Built Distribution
Close
Hashes for cdktf_local_exec-0.2.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a31e13d22b90d4b3e7eaa42fe94d23f4d3b3f9d729c55b56cdf81be2628b42d2 |
|
MD5 | 82cb260ae383f7f8a1387b1ebc508bf2 |
|
BLAKE2b-256 | b25bef411fa3bd33a023c3bd4fc09d2150bd13cd6a0d7f153766c83cab94f558 |