Manage workflows

Available in VPC

This section explains how to create, edit, delete, and view a list of workflows, along with guidance on how to configure workflows using the Visual Editor and YAML Editor.

Workflow list

SourceBand-workflow-use-manage_workflow_list

Area	Description
① Search	You can search for created workflows using the search bar. The repository list displays repositories integrated with the project.
② Create	Create workflow
③ Edit	Edit workflow
④ Delete	Delete workflow
⑤ Workflow list	You can view the list of created workflows.

Create workflow

To create a workflow, follow these steps:

From the SourceBand project page, click CI/CD > Workflow to go to the workflow list page.
Click [Create].
When the workflow creation page appears, follow these steps in order:

1. Workflow settings

Workflow name
- You can use the default workflow name or enter a name of your choice.
- The entered name is written in the Name field of the YAML definition file.
Source repository
- Select the source repository to store the workflow definition file.
- The source repository list shows SourceCommit repositories integrated with the project.
Branch
- Select the branch to save the workflow definition file.
Commit message
- You can use the default commit message or enter a custom message.
Workflow file name
- You can use the default workflow file name or enter a custom file name.
- The file is saved in the selected source repository and the .sourceband/workflows folder in the branch

2. Workflow configuration

SourceBand-workflow-use-manage_workflow_create_visual

Area	Description
① Switch between Visual/YAML modes	Visual: a visual editor that allows easy configuration. YAML: you can write codes directly in YAML format for configuration.
② Edit information	You can check workflow information such as name, repository, file path, and trigger.
③ Action	When you click the [+] button, the latest version of an action is added to the workflow. For more information about the action, click the action card to open a popup with details.
④ Visual	You can configure the workflow in Visual format.
⑤ Action group	Action group configuration is not supported in the Visual Editor and must be set up using YAML. For more information on YAML configuration, see Workflow format - YAML.
⑥ Action details	Click on each action to configure and view its details.
⑦ Set preceding action	This is an optional setting that lets you specify a preceding action that must be completed before the current action runs. For more information on dependencies, see Workflow format - YAML.

SourceBand-workflow-use-manage_workflow_create_yaml

Area	Description
① YAML	You can configure the workflow by writing codes directly in YAML format.

SourceBand-workflow-use-manage_action_detail

Area	Description
① Version	You can select from various available versions of an action.
② Action YAML	You can preview the YAML definition of the selected version of the action.
③ Add to workflow	After selecting a version, click the [Add to workflow] button to add that version of the action to the workflow.

3. Final confirmation

After reviewing the settings, click the [Save] button.

View workflow details

From the SourceBand project page, click CI/CD > Workflow to go to the workflow list page.
In the workflow list row, click the name of the workflow you want to check.
You can check the details of the selected workflow.
- Click the [Open YAML] button at the top to view the configured YAML definition file.
- Click an action to view the details of its configuration.

Edit workflow

From the workflow list page

From the SourceBand project page, click CI/CD > Workflow to go to the workflow list page.
To edit a workflow, click the ⋯ > [Edit] button on the right side of the workflow you want to edit.
Edit the workflow.
- For more information, see 2. Workflow configuration in Create workflow.
After completing your edits, click the [Save] button.

From the workflow details page

From the SourceBand project page, click CI/CD > Workflow to go to the workflow list page.
In the workflow list row, click the name of the workflow you want to check.
Click the [Edit] button.
Edit the workflow.
- For more information, see 2. Workflow configuration in Create workflow.
After completing your edits, click the [Save] button.

Delete workflow

From the SourceBand project page, click CI/CD > Workflow to go to the workflow list page.
To delete a workflow, click the ⋯ > [Delete] button on the right side of the workflow you want to delete.
Enter the name of the workflow you want to delete into the Delete workflow popup window and click the [Delete] button.

Caution

When a workflow is deleted, the corresponding YAML definition file in the repository is also deleted.