typescript.md

Getting Started (TypeScript)

Install the CLI

The first step to using cdkactions is installing the cdkactions CLI which can be installed using npm or yarn:

npm install -g cdkactions-cli
yarn global add cdkactions-cli

Create a New Project

Navigate to the .github folder within your git repo and run the following commands:

mkdir -p workflows cdk
cd cdk
cdkactions init typescript-app

This will:

• Create a workflows directory if one doesn't already exist
• Create a cdk directory and add all the required configuration to use cdkactions.

Use cdkactions

The final step is to actually use cdkactions. See the examples directory or the API guide for additional information.

Tips & Tricks

When defining a multiline run command for a step inside of a job, a package like ts-dedent may be useful to strip additional indentation from multiline strings. See the PyPI Publish example for an example of how to use it.

API Reference

To see a list of all cdkactions constructs and properties see the API reference

Synthesize manifests

When you make changes to your cdkactions project and want to update the .yaml manifests, just run the following command in the cdk folder:

yarn build