Manage workflows
This page describes how to configure Codeflow workflows and manage execution history.
Configure workflow
A workflow automatically performs jobs defined based on code changes or user execution requests. Workflows are defined as YAML files in a repository and are applied based on files under .codeflow/workflows in the default branch.
| Item | Description |
|---|---|
| Path | .codeflow/workflows |
| File format | YAML (.yml, .yaml) |
| Application standard | Based on the default branch |
Trigger events
Workflows run when trigger events defined in the workflow file occur. Codeflow supports the following events.
| Event | Description |
|---|---|
push | Automatically runs the workflow when commits are pushed to the repository |
workflow_dispatch | Allows a user to manually run the workflow - If parameters are defined, users enter values when running the workflow |
Codeflow currently supports the two trigger events listed above: push and workflow_dispatch.
Getting started
To run a workflow, create a repository, add a workflow file to the default branch, and configure a runner.
- Create a repository.
- Add a YAML workflow file under
.codeflow/workflowsin the default branch. Workflow files must be in the default branch to appear in the list. - Configure a runner.
- Refer to Workflow file list and execution in this document to run the workflow and check the result.
For an example of building a container image with a workflow and updating deployment manifests, see the Build a CI/CD pipeline with Codeflow and Deployflow tutorial.
Workflow file list and execution
In the Workflows tab of the repository details page, you can check and run workflow files configured in the default branch.
| Item | Description |
|---|---|
| Name | Workflow file name |
| Last modified at | Time when the file was last modified |
| Quick run | Enter parameter values and run the workflow |
Click Run workflow in the workflow file list to enter the branch and parameter values to run. If you select a branch other than the default branch, the workflow file with the same name in that branch is executed. Input items for workflow execution are automatically configured according to the workflow definition.
| Item | Description |
|---|---|
| Required | Required items are marked with * |
| Default value | Automatically entered when a default value exists |
| Placeholder | Guide text for the input format |
| Validation | Restricts execution when the input value does not meet the conditions |
Input methods differ depending on the parameter type defined in the workflow.
| Type | Input method | Description |
|---|---|---|
| text | Input field | Enter a string value |
| number | Number input field | Enter a numeric value |
| boolean | Selection button | Select True/False |
| choice | Dropdown | Select from predefined items |
Workflow execution history
In the Workflows tab of the repository details page, you can view workflow execution history and check execution results and status.
| Item | Description |
|---|---|
| Executed at | Time when the workflow was executed |
| Execution file name | Name of the executed workflow file |
| Branch | Branch where the workflow was executed |
| Execution result | Execution result status - Succeeded: Execution succeeded- Failed: Execution failed- Running: Execution is in progress- Queued: Execution is queued- Canceled: Execution was canceled |
| Executor | User who executed the workflow |
| Uptime | Time taken until execution completed |
Cancel workflow execution
If the workflow execution status is Running or Queued, you can cancel execution. In the execution history list, select [⋮] button > Cancel execution for the target item, check the content in the popup, and click [Cancel execution].
View workflow logs
To view workflow execution logs, select [⋮] button > View logs for the target item in the execution history list. After checking the logs, click [Close] in the popup.
Delete workflow execution history
If the workflow execution status is not Running or Queued, you can delete execution history. In the execution history list, select [⋮] button > Delete for the target item, check the content in the popup, and click [Delete].