Skip to main content

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

Status: Tech Preview Releases LICENSE build

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.

cdktf-local-exec is in technical preview, which means it's a community supported project. It still requires extensive testing and polishing to mature into a HashiCorp officially supported project. Please file issues generously and detail your experience while using the library. We welcome your feedback.

By using the software in this repository, you acknowledge that:

  • cdktf-local-exec is still in development, may change, and has not been released as a commercial product by HashiCorp and is not currently supported in any way by HashiCorp.
  • cdktf-local-exec is provided on an "as-is" basis, and may include bugs, errors, or other issues.
  • cdktf-local-exec is NOT INTENDED FOR PRODUCTION USE, use of the Software may result in unexpected results, loss of data, or other unexpected results, and HashiCorp disclaims any and all liability resulting from use of cdktf-local-exec.
  • HashiCorp reserves all rights to make all decisions about the features, functionality and commercial release (or non-release) of cdktf-local-exec, at any time and without any obligation or liability whatsoever.

Compatibility

  • cdktf >= 0.20.0
  • constructs >= 10.0.25

How It Works

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 the cwd directory into a tmp dir and run there. If false, the command will be executed in the cwd 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.5.10.tar.gz (34.6 kB view details)

Uploaded Source

Built Distribution

cdktf_local_exec-0.5.10-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

Details for the file cdktf-local-exec-0.5.10.tar.gz.

File metadata

  • Download URL: cdktf-local-exec-0.5.10.tar.gz
  • Upload date:
  • Size: 34.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for cdktf-local-exec-0.5.10.tar.gz
Algorithm Hash digest
SHA256 9e51234916b0137b20b8537e5ece8a96b11a568804026e75910d1012a6998671
MD5 0f9ac6a5f76e2128a4fcf79735f8b9d9
BLAKE2b-256 da863235fcbfc3ca3a842de679b9f5bc368edf411158ba5b6bc4c6b66f7d25d9

See more details on using hashes here.

File details

Details for the file cdktf_local_exec-0.5.10-py3-none-any.whl.

File metadata

File hashes

Hashes for cdktf_local_exec-0.5.10-py3-none-any.whl
Algorithm Hash digest
SHA256 8d6094a011e60522d9e2a598a1e5469a8159f33d299828e5919a64373f6590fd
MD5 26511c268a4e028d708d66415f6a6fd3
BLAKE2b-256 ad6e58e29524cbd867ed1f53932a607a9a23d4f1712a5acbcaf01bddee341166

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