Workflow Syntax

Like the Github actions workflows, a Actionsflow workflow is a configurable automated process made up of one or more jobs. You must create a YAML file to define your workflow configuration. The Actionsflow configuration format is the same as Github actions'.

Workflow files use YAML syntax and must have either a .yml or .yaml file extension. If you're new to YAML and want to learn more, see "Learn YAML in five minutes".

You must store workflow files in the workflows directory on your repository.

A typical workflow file workflow.yml looks like this:

on:
rss:
url: https://hnrss.org/newest?points=300
jobs:
ifttt:
name: Make a Request to IFTTT
runs-on: ubuntu-latest
steps:
- uses: actionsflow/ifttt-webhook-action@v1
with:
event: notice
key: ${{ secrets.IFTTT_KEY }}
value1: ${{on.rss.outputs.title}}
value2: ${{on.rss.outputs.contentSnippet}}
value3: ${{on.rss.outputs.link}}

The following doc will give you more details on the workflow syntax:

on

Required. The name of the Actionsflow trigger. Triggers are how your workflows can start automated workflows whenever they add or update something in your workflow.

For a list of available triggers, see "Triggers".

Example using RSS trigger:

on:
rss:
url: https://hnrss.org/newest?points=300

Context and expression syntax for Actionsflow on:

You can access context information in workflow triggers. You need to use specific syntax to tell Actionsflow to evaluate a variable rather than treat it as a string:

${{ <context> }}

For now, you can use secrets and github as trigger's context. The two objects are set by Github actions and you can use them in the trigger config. For example:

on:
telegram_bot:
token: ${{ secrets.TELEGRAM_BOT_TOKEN }}

on.<trigger>

Optional. The trigger's options. The default value is {} and you can find the available params in the trigger's documentation.

on.<trigger>.config

Optional. You can use config to configure the general options for the Actionsflow trigger. These options are handled by Actionsflow, so all triggers accept these configurations.

For example:

on:
rss:
url: https://hnrss.org/newest?points=300
config:
limit: 15

The config key has the following options:

on.<trigger>.config.every

Optional, number or string. The interval of time in which the trigger should run. If the every value type is number, the unit is minute. The default value is 0, which means the trigger will be ran once every Github Actionsflow workflow runs. But due to the limitation of the shortest interval of github actions, generally Actionsflow will run once every 5 minutes.

You can use number to specify the interval of time for running a trigger. Using 60, means the trigger will be ran once every 60 minutes. You can also use a cron expression for the every option. For example, you can use 1 * * * * to run every 60 minutes (now using the cron expression syntax). We use cron-parser to parse cron expression, allowing you to define a more complex trigger schedule.

For example, if you want to run a trigger at 7:00 AM weekly, you can use the following config:

on:
rss:
url: https://hnrss.org/newest?points=300
config:
every: "0 7 * * 1-5"

Note: the default time zone is UTC, so if you set a cron expression, you should take that into account. You can also change the time zone by using on.<trigger>.config.timeZone.

Note: webhook events will ignore the every config.

on.<trigger>.config.timeZone

Optional. string, time zone, the default value is UTC, used for parsing on.<trigger>.config.every cron expression, see more time zone string at here.

on.<trigger>.config.filter

Optional, MongoDB query language. You can use filter to filter the trigger's results as you need.

Actionsflow use mingo(A tool to use MongoDB query language for in-memory objects) for filter the trigger's results. For example, the following workflow will only be triggered when RSS feed title contains interviews:

on:
rss:
url: https://hnrss.org/newest?points=300
config:
filter:
title:
$regex: interviews

Learn more about MongoDB query language, please see MongoDB query documents and mingo.

on.<trigger>.config.filterOutputs

Optional, MongoDB query language projection syntax. You can use filterOutputs to filter the results fields of the trigger's outputs as you need.

Actionsflow uses mingo (a tool to use MongoDB query language for in-memory objects) to filter the trigger's outputs. For example, the following email trigger outputs which include date, subject, and subject will only include the first 7 bytes:

on:
email:
imap:
host: outlook.office365.com
user: ${{secrets.EMAIL_USER}}
password: ${{secrets.EMAIL_PASSWORD}}
config:
filterOutputs:
date: 1
subject:
$substrBytes:
- $subject
- 0
- 7

The resulting outputs when the trigger runs will include date, subject key:

{
"outcome": "success",
"conclusion": "success",
"outputs": {
"date": "2020-09-15T21:14:26.000Z",
"subject": "Hello"
}
}

To learn more about MongoDB query projection syntax, please see MongoDB query language projection syntax and mingo.

on.<trigger>.config.format

Optional, js function code. You can use format to filter results fields of the trigger's outputs as you need. format will be called after filterOutputs. You can use format like this:

name: A really complex example
on:
poll:
url: https://jsonplaceholder.typicode.com/posts
config:
format: |
item.title = item.title.substring(0,5)
return item;

on.<trigger>.config.sort

Optional, MongoDB query language sort syntax. You can use sort to change the order of the trigger's results as you need.

Actionsflow uses mingo (a tool to use MongoDB query language for in-memory objects) to sort the trigger's results. For example, the following workflow will sort the triggers results by descending order:

on:
poll:
url: https://jsonplaceholder.typicode.com/posts
config:
limit: 1
sort:
id: -1

To learn more about MongoDB query sort syntax, please see MongoDB query language sort syntax and mingo.

on.<trigger>.config.limit

Optional, number. The trigger's results max length. The default value is undefined, which means the trigger will handle all items.

on.<trigger>.config.skip

Optional, number. Skip <count> results of the trigger's results. The default value is undefined, which means the trigger will handle all items.

on.<trigger>.config.active

Optional, boolean. Configures whether the trigger is active (defaults to true). You can deactivate triggers by setting active: false.

on.<trigger>.config.skipFirst

Optional, boolean. Configures whether the trigger skips the first time data is obtained. If true, the trigger will run the next time it get data. The default value is false.

on.<trigger>.config.shouldDeduplicate

Optional, boolean. Configures if the trigger's results should be deduplicated. The default value is dictated by the trigger. You use this setting to override the trigger's default configuration.

on.<trigger>.config.manualRunEvent

Optional, string or string[]. Github actions events that should trigger this trigger to run manually. The default value is [], but you can use push, workflow_dispatch and repository_dispatch as values.

For example, if you set a trigger's every configuration as 1 2 * * * and you don't want to wait to 02:01 to test your trigger, you can config workflow_dispatch as a trigger's manualRunEvent. Then, if a workflow_dispatch event occurs, your trigger will be triggered.

on.<trigger>.config.force

Optional, boolean. Whether to force data to be updated. If true, the trigger will ignore cache, every, and last update time. The default value is false.

on.<trigger>.config.skipOnError

Optional, boolean. Set to true for Actionsflow to ignore the error of this trigger when it runs and fails. The default value is false, Actionsflow will throw an error finally, Github may send an email to notice you the error.

on.<trigger>.config.buildOutputsOnError

Optional, boolean. Set to true, Actionsflow will build a workflow with on.<trigger>.outcome as true, on.<trigger>.outputs as {} from failing when a trigger fails. The default value is false - Actionsflow will skip the build outputs for this trigger this time.

on.<trigger>.config.logLevel

Optional, string. Log level for trigger. The default value is info but you can use trace, debug, info, warn and error.

on.<trigger>.config.debug

Optional, boolean. Whether the trigger enables debug mode or not. The default value is false. If true, then the logLevel will be debug, and the trigger will be triggered when any event occurs (like push, workflow_dispatch, repository_dispatch).

on.<trigger>.config.skipSchedule

Optional, boolean. Whether the trigger should skip schedule event. The default is false. If true, the trigger will ignore the every param and not run when triggered by the schedule event. Use this param when you want a trigger to run only manually.

on.<trigger>.<param>

Optional. The trigger's options, defined by the specific trigger. You should read the trigger's documentation to see all available options for the trigger. For example, for the rss trigger:

on:
rss:
url: https://hnrss.org/newest?points=300
config:
limit: 15

jobs

A workflow run is made up of one or more jobs. Jobs run in parallel by default. To run jobs sequentially, you can define dependencies on other jobs using the jobs.<job_id>.needs keyword.

The jobs configuration format is the same as Github actions jobs, so you can learn more about them here.

Actionsflow supports almost all Github actions by using act (a tool for running GitHub Actions locally).

A typical job looks like this:

jobs:
ifttt:
name: Make a Request to IFTTT
runs-on: ubuntu-latest
steps:
- uses: actionsflow/ifttt-webhook-action@v1
with:
event: notice
key: ${{ secrets.IFTTT_KEY }}
value1: ${{ on.rss.outputs.title }}
value2: ${{ on.rss.outputs.contentSnippet }}
value3: ${{ on.rss.outputs.link }}

For more actions, please see Awesome Actions List we Collected and Github Actions Marketplace.

Context and expression syntax for Actionsflow jobs:

You can access context information in workflow jobs. You need to use specific syntax to tell Actionsflow to evaluate a variable rather than treat it as a string:

${{ <context> }}

All Github actions contexts and expressions are supported by Actionsflow, and we extend the on context for the trigger's results. You can use it like this:

${{ on.<trigger>.outputs.<key> }}

You can find params and outputs keys supported by the trigger by looking at the trigger's documentation.

All triggers will export the following key:

on.<trigger>.outputs

A map of outputs for a trigger's result item. The trigger's outputs are available on all jobs.

Trigger outputs are objects. You can use them like this: ${{ on.telegram_bot.from.first_name }}

By default, on.<trigger>.outputs will always be available, unless you set buildOutputsOnError as true. When buildOutputsOnError is true, and the trigger runs with an error, then the outputs will be {}. You can use on.<trigger>.outcome to check if the trigger is triggering errors. When on.<trigger>.outcome is failure, then the on.<trigger>.outputs will be {}.

on.<trigger>.outcome

The result of a completed trigger. Possible values are success, failure, or skipped.

If there is only one trigger on a workflow file, by default, outcome will always be success. If you set the trigger options buildOutputsOnError: true and the trigger runs with an error, the outcome will be failure, but the final conclusion is success.

If you set multiple triggers on one workflow, only one trigger's outcome is success. The other outcomes will be skipped, so you should use if: on.<trigger>.outcome === 'success' to ensure the current <trigger>.outputs.<key> is available.

on.<trigger>.conclusion

The result of a completed trigger. Possible values are success, or skipped.

If there is only one trigger on a workflow file, conclusion will always be success.

If you set multiple triggers on one workflow, only one trigger's conclusion is success, the other conclusions will be skipped.

Learn More

For a list of available triggers, see Trigger List.

For a list of awesome workflows, see Awesome Actionsflow Workflows.