Skip to main content

Hex - Run Project

Overview​

First time using this Blueprint? Make sure you follow our Hex authorization guide.​

Immediately runs a Hex project. The project must already be set up and published within the Hex interface.

This Blueprint will run a Hex project and will not wait around to verify if the sync was successfully completed, but it will create and store the source ID used to shipyard-artifacts/hex-blueprints/variables/runId.pickle

Recommended Setup:

  1. This Vessel should be immediately followed by a Vessel built from the Check Run Status Blueprint so you can verify the status and completion of your request.
  2. The Hex project being triggered should not be scheduled to refresh in Hex, in order to avoid conflicting run times.

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
Project IDHEX_PROJECT_IDAlphanumeric✅--The Project Id can be acquired from the project URL itself or from within the project's variables section. See authorization page for more.
API TokenHEX_API_TOKENPassword✅--The API token is generated by Hex for a set amount of time. See authorization page for more

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
  blueprint: Hex - Run Project
  inputs:
    HEX_PROJECT_ID: null ## REQUIRED
    HEX_API_TOKEN: null ## REQUIRED
  type: BLUEPRINT
guardrails:
  retry_count: 0
  retry_wait: 0s
  runtime_cutoff: 4h0m0s
  exclude_exit_code_ranges:
    - "201-226"