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 thecwddirectory into a tmp dir and run there. If false, the command will be executed in thecwddirectory.
2 maintainers
Metadata
2 maintainers
Release files for cdktf-local-exec 0.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| cdktf-local-exec-0.0.6.tar.gz | 23.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cdktf_local_exec-0.0.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 46.2 kB
Release files / cdktf-local-exec-0.0.6.tar.gz
| Download URL | cdktf-local-exec-0.0.6.tar.gz |
|---|---|
| Size | 23.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b3c027585d8543c0c61013597cea6a3a2c148b18fa17649e30d6568c8e53cfb9
|
|
BLAKE2b-256 checksum How to use checksums |
a361358260a5de3addb3da31375d0d44ee5a12f76b4c13e94880ea6a3387ba1b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
|
Release files / cdktf_local_exec-0.0.6-py3-none-any.whl
| Download URL | cdktf_local_exec-0.0.6-py3-none-any.whl |
|---|---|
| Size | 22.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2848a983d67f7d3c47cd75a876b2af747a42682929c4a0892cc2f2272456fc82
|
|
BLAKE2b-256 checksum How to use checksums |
0e7f110f47b4745080fdde659c04aef8c5565c8689f7e267f586e6eaf6266d8a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
|
Security for cdktf-local-exec 0.0.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
