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.27.tar.gz
(28.7 kB
view details)
Built Distribution
File details
Details for the file cdktf-local-exec-0.2.27.tar.gz
.
File metadata
- Download URL: cdktf-local-exec-0.2.27.tar.gz
- Upload date:
- Size: 28.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 026774fba5cc5996eb63c5b6b93857f6a1b72b4a28c9e777c74f244893ba9348 |
|
MD5 | 439a8c7f67ed10566e75a53ab2b32371 |
|
BLAKE2b-256 | a1c05f2fd8be084109fe437189172416f9cdac69716e4484733e5bd230da49f2 |
File details
Details for the file cdktf_local_exec-0.2.27-py3-none-any.whl
.
File metadata
- Download URL: cdktf_local_exec-0.2.27-py3-none-any.whl
- Upload date:
- Size: 27.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | dbf221277ec9d9f001716c92bd676df0c76d9012ad6478fe5dce519910315acb |
|
MD5 | 5d4731341835479a1b669cede8cc0f5f |
|
BLAKE2b-256 | 31803c8340a92b412b1a4637d8e8798fa0de057aed73043bda49db99467f6ea4 |