Workflow format - YAML

Available in VPC

Workflow files must be written in a predefined format to be recognized as valid and executable.
This section explains the YAML format required for defining a workflow and the meaning of each property.

Basic structure of workflow

Name: <workflow-name>
Version: v1
Triggers:
  - Type: PUSH
    Branches:
      - main
Actions:
  <action-name>:
    # Identifies the action. Do not modify this value.
    Identifier: ncp/sourcebuild@v1.0.0
    # Defines the action's properties.
    Config:
       ....

Workflow name

You can specify the name of the workflow.
The name must meet the following conditions:

• Must be at least 1 character.
• Must be less than 100 characters.
• Only uppercase and lowercase letters (A to Z and a to z), numbers (0 to 9), hyphens (-), and underscores (_) are allowed.

Workflow schema version

You can explicitly specify the version of the workflow schema.

Workflow trigger setting

A workflow trigger defines when the workflow should automatically run in response to a specific event.

Triggers are defined in a list format, and multiple triggers can be set in parallel.
Currently, only the PUSH trigger is supported. Other types such as PR and SCHEDULE will be added in the future.
Trigger configuration must follow the following format:

Push trigger (type: PUSH)

Push trigger is configured to run the workflow when a Push event occurs in the repository.

Triggers:
  - Type: PUSH
    Branches:
      - main
      - dev

In the example above, the workflow runs if a Push event occurs in the main or dev branch.

To detect Push events in all branches without restriction, you may omit the Branches property.

Triggers:
  - Type: PUSH

Basic structure of workflow action

An "action" refers to a unit of task that is actually executed within a workflow. The Actions property is required, which defines one or more actions.
Actions are executed in a defined order or based on specified conditions, performing various tasks such as building or deploying resources depending on how the actions are defined.

Actions:
  <action-name>:
    # Identifies the action. Do not modify this value.
    Identifier: ncp/sourcebuild@v1.0.0
    # Defines the action's properties.
    Config:
      # Specifies the resource you want to use
      Resource:
        ...
    DependsOn:
      - <previous-action>

Action names are used as keys of the Actions sub-object, and they must be unique. Each action has the following properties:

Identifier

Identifier is a unique identifier used to specify the action to execute.
If the identifier format is incorrect, validation may fail.

Example: ncp/sourcebuild@v1.0.0

Config

Config is the section where you define the configuration values for running each action.
Since the format of this property depends on the action's identifier, you must check the appropriate format for each action.

For detailed config formatting, see Workflow action list.

DependsOn

DependsOn is the property used to specify an action that must be completed before the current one runs.
You can define it by listing action or action group names, which is useful when actions need to run in sequence.

Action group feature

You can group multiple actions into a single group to configure a logical unit.

Actions:
  <action-group-name>:
    Actions:
      <action-name-1>:
        ....
        DependsOn:
	      - <action-name-2>
      <action-name-2>:
        ....
    DependsOn:
      - <other-action-name>

When the Actions property is added under an action name, that section is treated as an action group.
Description of the properties under an action group are as follows:

Workflow validation

A workflow file is considered valid only if it meets the following conditions:

• No YAML syntax errors.
• Follows the schema without missing required properties.
• No duplicate action names or group names.
• Does not reference undefined names in DependsOn.

If these conditions are not met, the workflow is classified as invalid and cannot be executed.

Full example

Name: example-workflow
Version: v1
Triggers:
  - Type: PUSH
    Branches:
      - main
Actions:
  build:
    Identifier: ncp/sourcebuild@v1.0.0
    Config:
      Resource:
        ProjectName: example
  deploy:
    Identifier: ncp/sourcedeploy-server@v1.0.0
    Config:
      Resource:
        ProjectName: example
        StageName: example-stage
        ScenarioName: example-scenario
    DependsOn:
      - build