Workflow prerequisites

Available in VPC

The workflow feature enables CI/CD automation and pipeline setup. You can define a workflow using either the Visual Editor or YAML and manage the definition files by integrating them with a SourceCommit repository. This allows you to track who did which tasks and when. You can easily review changes and rollback when needed, which helps team members collaborate effectively and boosts the trustworthiness of build and deployment processes.

Caution

Workflow is temporarily provided free of charge. If it is upgraded to paid plans, a separate notice will be given in advance.

Workflow definition file

Workflows are defined in a .yaml format and are stored in the following path within the SourceCommit repository:

.sourceband/workflows/*.yaml

Each workflow is managed as a separate YAML file, and you can freely name each file.
For more information on the workflow definition file, see Workflow format - YAML.

Workflow components

Action

An action is a unit of task executed within a workflow. A workflow includes multiple actions, which can be configured to run sequentially or in parallel.

For more information on actions, see Workflow format - YAML.

Action group

An action group is a unit that combines one or more actions. It helps you structure and manage the workflow more efficiently. You can also set dependencies between action groups, allowing the next group to run after a specific group is completed.

For more information on action groups, see Workflow format - YAML.

Triggers

Workflow triggers allow a workflow to automatically run when a specific event occurs.
The following trigger types are available:

Push: automatically runs the workflow when codes are committed (pushed) to a specific branch in the repository containing the workflow definition file.

For more information on triggers, see Workflow format - YAML.

Workflow status

Status	Description
Active	The workflow definition file is valid and in an executable state. There is no trigger, or the push trigger includes the current branch.
Inactive	The workflow definition file is valid but not executable. The push trigger does not include the current branch, and the workflow cannot be executed from that branch. For example, if the workflow file exists in both the main and develop branches but the trigger is configured only for the develop branch, the workflow in the main branch is marked as Inactive. This ensures that even if the same workflow definition exists across multiple branches, it only runs in branches that match the trigger conditions.
Invalid	The workflow definition contains an error and cannot be executed.

Workflow prerequisites

Repository integrations

The workflow definition file is stored in a SourceCommit repository. To create a workflow, you must integrate a SourceCommit repository with your SourceBand project. For more information on integrations, see SourceCommit product integrations.

Caution

Precautions for repository integration
- Even if a workflow definition file already exists in the repository, the workflow is not created immediately after the integration with the project.
  A commit must occur in the branch containing the workflow definition file for it to be created.
Precautions for repository disconnection
- When a repository is disconnected, all workflows in the repository are deleted.
- However, the YAML files in the repository are not deleted.

Workflow management methods

You can manage workflows using either the console UI or Git CLI:

Method	Description
Console UI	You can visually create, edit, and delete workflows in the console. Both Visual Editor and YAML Editor are supported.
Git CLI	You can create, edit, and delete YAML files directly in the `.sourceband/workflows/` folder using the Git CLI.	****