Options
All
  • Public
  • Public/Protected
  • All
Menu

Contributing a Workflow

The process of adding a workflow is straightforward and requires no code, but you are likely to be adding a new feature with a new workflow, which is a slightly more involved process. Check Features to learn more.

  1. Create a .yml file in workflow/src with the name of your workflow
  2. Fill out the following details
# User Facing Name of your Workflow
name: Compress-Transcode
# User Facing Description of your Workflow
description: Workflow to compress and transcode your videos
# Which features to execute in order
# The features name are not case sensitive
steps:
  - Compress
  - Transcode

Find the list of features at Features

  1. Submit Pull Request! Please give a detailed description of your pull request

Advanced Workflows

Certain features can accept configurations from workflows directly, and perform more complex tasks. For these features, the workflow syntax should be slightly different

Example, COMBINED_EXEC_FEATURE this feature runs multiple feature together instead of back to back

# User Facing Name of your Workflow
name: Compress-Greyscale
# User Facing Description of your Workflow
description: Workflow to grayscale and compress your videos
# Which features to execute in order
# The features name are not case sensitive
steps:
  - name: COMBINED_EXEC_FEATURE
    steps:
      - Compress
      - Greyscale

Each sub feature, here can have the same configuration too! So you can chain COMBINED_EXEC_FEATURE within each other

Any configuration can be passed as configuration here, but you should check what configuration the feature accepts

Generated using TypeDoc