Starting a workflow manually in a SourceCraft repository

In addition to automatically starting CI/CD workflows based on specific trigger events, you can start the process manually from the SourceCraft interface.

Simple start

1. Configure CI/CD in your repository.

2. Open the SourceCraft home page.

3. On the Home tab, under Your craftspace, navigate to Repositories and select your repository.

4. Under Code on the repository page, go to CI/CD.

5. At the top right, click New launch and configure the start:

   1. Select the branch housing the .sourcecraft/ci.yaml file with the workflow you need.
   2. Select a workflow.
   3. Select a branch to start the workflow in.
   4. Click Launch now.

6. Check the workflow run:

   1. Under Code on the repository page, go to CI/CD.
   2. Select a running workflow.
   3. The page that opens will display all workflow tasks, cubes (task steps), as well as statuses and execution results.

Starting with custom parameters

1. Configure CI/CD in your repository.

2. Open the SourceCraft home page.

3. On the Home tab, under Your craftspace, navigate to Repositories and select your repository.

4. Under Code on the repository page, go to Branches.

5. Select the branch for editing.

6. Open the .sourcecraft/ci.yaml file.

7. In the top-right corner, click Edit.

8. Add the inputs block to the workflow parameters. Here is an example:

   workflows:
     test-workflow:
       inputs:
         username:
           type: string
           required: true
           default: John Doe
           description: Required string value.
         show-name:
           type: bool
           default: true
           description: Optional Boolean value: true or false. Default value is true.
         language:
           type: choice
           default: Russian
           options:
             - Russian
             - English
             - Chinese
           description: Optional value: select one. Default value is Russian.
   
       tasks:
         - name: sample-task
           env:
             # Replace with the names of the elements from the inputs block,
             # such as inputs.username, inputs.show-name, inputs.language.
             NAME: ${{ inputs.<name_of_first_element_from_inputs> }}
             SHOW_NAME: ${{ inputs.<name_of_second_element_from_inputs> }}
             LANGUAGE: ${{ inputs.<name_of_third_element_from_inputs> }}
           cubes:
             - name: sample-cube
               script:
                 - |
                   case "$LANGUAGE" in
                       "Russian")
                           echo "Hello world!"
                           if [ "$SHOW_NAME" = "true" ]; then
                               echo "My name is $NAME."
                           fi
                           ;;
                       "English")
                           echo "Hello, world!"
                           if [ "$SHOW_NAME" = "true" ]; then
                               echo "My name is $NAME."
                           fi
                           ;;
                       "Chinese")
                           echo "你好，世界！"
                           if [ "$SHOW_NAME" = "true" ]; then
                               echo "我的名字是 $NAME。"
                           fi
                           ;;
                   esac
   
   on:
     push: test-workflow
   

   Where:

   • type: Parameter type. The possible values are:

     • string: String.
     • bool: Logical value, true or false.
     • choice: Select from the preset values.

     Note

     If the configuration contains the options parameter, you do not need to set the type: choice parameter.

     If the type is not specified and there is no options parameter, the default parameter type is string.

   • required: Required parameter. The possible values are true or false.

   • description: Any description of the parameter that will be displayed in the SourceCraft interface when manually running the workflow.

   • default: Default parameter value. You can also specify it if the parameter is required.

   • options: Possible values ​​for the choice parameter type.

9. In the top-right corner, click Commit changes.

10. In the window that opens, configure the change parameters:

    • In the Commit message field, specify the comment describing the changes you have made.
    • Under Commit branch, select the branch you want to edit. If required, create a new branch.
    • Under After commit action, select how to make changes: via a commit or a pull request.

11. Confirm your changes.

    If you opt to submit a pull request, finish creating one.

12. Under Code on the repository page, go to CI/CD.

13. At the top right, click New launch and configure the start:

    1. Select the branch housing the .sourcecraft/ci.yaml file with the workflow you need.
    2. Select a workflow.
    3. Select a branch to start the workflow in.
    4. Fill in the other parameters.
    5. Click Launch now.

14. Check the workflow run:

    1. Under Code on the repository page, go to CI/CD.
    2. Select a running workflow.
    3. The page that opens will display all workflow tasks, cubes (task steps), as well as statuses and execution results.

See also

• Configuring CI/CD in a SourceCraft repository
• Continuous integration and continuous deployment in SourceCraft
• CI/CD reference