Build and Push

Building your project locally

After defining a workflow, you can use the para CLI to validate and build the workflow to prepare to upload it to the Paragon dashboard. Building workflows creates a subfolder in your project called out/ with auto-generated files.

You can build all workflows in your project with the build command:

para build

If your build is successful, you will see:

✓ Typescript project successfully built.
✓ Created build in out/build.json file.

Otherwise, see Diagnosing build errors below to address build errors.

Pushing your project to Paragon

Try Git Sync to configure an integration between your Paragraph files stored in a Git repository and your Paragon project.

Git Sync keeps your Paragon project and Paragraph repository automatically in-sync.

To upload on a one-off basis to your Paragon project, use the push command in the CLI.

para push
  • If your workflow has previously been pushed to your Paragon project, this command will overwrite any changes that have been made to this workflow with the current contents of the Paragraph file that you are pushing.

  • Workflows cannot be pushed to Staging or Production Release Environments. Create a Release to move integration updates from Main to Staging or from Staging to Production.

Pulling changes from Paragon

To pull changes from the dashboard on a one-off basis to your Paragon project, first commit all pending changes in your local repository, and then use the pull command in the CLI.

para pull
  • Any uncommitted changes may be overwritten by the pull command.

  • As with the push command, any integrations or workflows that are absent from the source (your Paragon dashboard in the pull case) will be removed from the destination (the local repository). The best way to reconcile these types of removals is with Git Sync, which will use your commits to sequence these changes.

Diagnosing build errors

The build command operates in 2 phases:

  1. A TypeScript compilation runs to check types for all of your workflows and integration configurations.

  2. The compilation result is evaluated to produce a build artifact to upload to Paragon, in out/build.json.

If you are encountering TypeScript compilation errors, they will appear as follows:

src/integrations/hubspot/workflows/newWorkflow.ts:31:25 - error TS2554: Expected 1 arguments, but got 0.

31     const triggerStep = new EventStep();
Found 1 error(s).

These errors are also visible in your editor, if you have a TypeScript language server running. TypeScript errors can be indicative of one of the following issues:


Missing or invalid parameters Steps have incomplete configurations, which does not produce a valid workflow.

Visit the workflows with incomplete steps and correct their configuration. If some workflow steps are intentionally incomplete (e.g. the workflow is a draft), you can prefix the filename with ~ to exclude it from the build.

Incorrect step output path referenced A step requires output from other steps, but the path it references is not valid.

Visit the workflows with invalid step output paths and correct references to .output. Use the TypeScript-powered autocomplete to help identify available properties.

Function step code is using unknown properties

Because Function step code in the dashboard does not use TypeScript, errors can appear in your exported Function steps about unsafely accessing properties in untyped values. These errors can help refactor your Function step code to be type-safe, but you can ignore them by using // @ts-ignore above lines that are causing errors.

Missing types from @useparagon/integrations

Integration-specific dependencies may be missing from your project. Run para install with the CLI to pull in missing dependencies.

If you are encountering many TypeScript compilation errors that should be ignored, you can attempt a build that suppresses these types of errors with the --skip-type-errors flag:

para build --skip-type-errors

Last updated