Available from: 2.0.0
Import
import { Pipeline } from "@supernovaio/sdk"
Properties
- id: The unique identifier of the pipeline. This ID provides a constant and unchanging reference to the pipeline entity.
- workspaceId: The unique identifier of the workspace to which the pipeline belongs. T
- designSystem: An object containing information about the design system associated with the pipeline, including:
- id: The unique identifier of the design system.
- meta: Metadata about the design system, including its name and description.
- name: The name of the pipeline, offering a human-readable label to identify it easily.
- isEnabled: A boolean value indicating whether the pipeline is currently enabled and active.
- eventType: The type of event that triggers the pipeline. This can be one of the following options:
- OnVersionReleased: Triggered when a new version is released.
- OnHeadChanged: Triggered when changes occur at the head of the design system.
- OnSourceUpdated: Triggered when the source data is updated.
- exporterId: The unique identifier of the exporter associated with the pipeline. This exporter defines the actions to be taken when the pipeline is triggered.
- destinations: An object containing destinations where pipeline actions are directed. These destinations may include:
- webhookUrl: A URL for sending webhook notifications.
- documentation: Configuration for documentation-related actions, specifying the environment (e.g., "Live" or "Preview").
- s3: Configuration for actions related to Amazon S3 storage.
- github: Configuration for actions related to GitHub repositories, including connection details, URL, branch, and relative path.
- azure: Configuration for actions related to Azure repositories, including connection details, organization, project, repository, branch, relative path, and URL.
- gitlab: Configuration for actions related to GitLab repositories, including connection details, project, branch, relative path, and URL.
- bitbucket: Configuration for actions related to Bitbucket repositories, including connection details, workspace, project key, repository slug, branch, relative path, and URL.
- brandId: The unique identifier of the brand associated with the pipeline, if applicable.