Skip to main content

​
Installation

This guide will walk you through setting up Kraken in your project.

​
Prerequisites

Before installing Kraken, you need to have cdkactions initialized in your project.

​
Initialize cdkactions

Follow the cdkactions getting started guide to initialize the cdkactions project. This will create a .github/cdk directory in your repository where you’ll define your workflows.

​
Install Kraken

Once cdkactions is set up, install Kraken as a dependency: 
npm install @pennlabs/kraken

​
Build and Commit

After configuring your Kraken stacks (see Quickstart), you need to build the workflows:
  1. Navigate to the cdkactions directory: 
    cd .github/cdk
  2. Build the workflows: 
    yarn build
  3. Commit the generated workflow files: 
    git add .
git commit -m "Add Kraken CI/CD workflows"
The build process will generate YAML workflow files in .github/workflows that GitHub Actions can execute.

​
Next Steps

Now that Kraken is installed, head over to the Quickstart guide to create your first workflow.

Build docs developers (and LLMs) love

Get started for freeTalk to us