- title: Cron (timer) triggers

The `triggers` field is an array of objects that hold [Git trigger information]({{site.baseurl}}/docs/pipelines/triggers/git-triggers/).

The `cronTriggers` field is an array of objects that hold [Cron trigger information]({{site.baseurl}}/docs/pipelines/triggers/cron-triggers/).

{: .table .table-bordered .table-hover}

| Field name | Parent field | Type | Value |

| -------------- | ---------------------------- |-------------------------| -------------------------|

| `event` | `cronTriggers` | string | Leave empty. Automatically generated by Codefresh for internal use. |

| `name` | `cronTriggers` | string | The user-defined name for the Cron trigger. |

| `message` | `cronTriggers` | string |The free-text message to be sent as an additional event payload every time the Cron trigger is activated. For example, `Successful ingress tests` |

| `expression` | `cronTriggers` | string |The Cron expression that defines the time and frequency of the Cron trigger.<br>For example, `0 3 * * 1-5` triggers the pipeline at _3:00 AM every weekday (Monday to Friday)_. |

| `disabled ` | `cronTriggers` | boolean | Determines if the Cron trigger is enabled for activation. <br>By default, set to `false` meaning that it is always enabled. <br>To disable the trigger, set to `true`. |

| `gitTriggerId` | `cronTriggers` | string | The ID of the Git trigger to simulate for the pipeline, retrieved from the pipeline for which it is defined.<br>To simulate a Git trigger, the pipeline must have at least one Git trigger defined for it.<br>See [Git triggers](#git-triggers) in this article. |

| `branch` | `cronTriggers` | string | Valid only when a Git trigger is simulated.<br> The branch of the repo retrieved from the Git trigger defined in `gitTriggerId`. |

| `variables` | `cronTriggers` | array | The environment variables to populate for the pipeline when the Cron trigger is activated. See [Variables in pipelines]({{site.baseurl}}/docs/pipelines/variables/). |

| `options` | `cronTriggers` | array | The behavior override options to implement for the current build. By default all overrides are set to `false`, meaning that the build inherits the default behavior set for the pipeline at the account level. <br>Can be any of the following:<br>{::nomarkdown}<ul><li><code class="highlighter-rouge">noCfCache</code>: When set to <code class="highlighter-rouge">true</code>, ignores Docker engine cache for build. See <a href="https://codefresh.io/docs/docs/kb/articles/disabling-codefresh-caching-mechanisms">Docker engine cache</a></li><li><code class="highlighter-rouge">noCache</code>: When set to <code class="highlighter-rouge">true</code>, ignores the last build's cache. Selecting this option may slow down your build.<br>See <a href="https://codefresh.io/docs/docs/kb/articles/disabling-codefresh-caching-mechanisms">Last build cache</a>.</li><li><code class="highlighter-rouge">resetVolume</code>: When set to <code class="highlighter-rouge">true</code>, resets the pipeline volume, useful for troubleshooting a build that hangs on the first step.<br> See <a href="https://codefresh.io/docs/docs/kb/articles/restoring-data-from-pre-existing-image-hangs-on/" target="_blank">Hangs on restoring data from pre-existing image</a>.</li><li><code class="highlighter-rouge">enableNotifications</code>: When set to <code class="highlighter-rouge">true</code>, sends email and Slack notifications, in addition to status updates to your Git provider.<br>See <a href="https://codefresh.io/docs/docs/integrations/notifications/slack-integration/" target="_blank">Slack notifications</a>.</li></ul>{:/}|

{% highlight yaml %}

{% raw %}

...

cronTriggers:

- name: SSO sync

type: cron,

message: "Sync successfull"

expression: "0 0/1 * 1/1 * *"

gitTriggerId: 64905de8589da959de81d31d

branch: main

variables: []

options:

noCfCache: false

noCache: false

resetVolume: false

enableNotifications: true

disabled: true

event: cron:codefresh:0 0/1 * 1/1 * *:tests:ecef63b9ed20

verified: true

status: verified

id: 64ddd8b04fdbcc74cc74fe80

...

{% endraw %}

{% endhighlight %}

title: "Cron (timer) triggers"

description: "Run pipelines on a time schedule"

Cron triggers offer a way to run Codefresh pipelines based on a specific time schedule. Cron triggers are particularly useful for tasks like regular maintenance, periodic checks, or any repetitive workflows.

Integrate additional settings in the Cron trigger such as simulating a Git event to enrich pipelines with repository details, adding/customizing environment variables, and caching, volume reuse, and notification configurations for the build.

By integrating these additional options, Cron triggers can initiate pipeline executions at the predefined time intervals and at the same time populate the pipeline with repo and branch information from the Git trigger, required environment variables, and specialized behavior, for the build.

Create and manage Cron triggers for pipelines through [Codefresh UI](#cron-triggers-in-codefresh-ui), as described in this article.

For the specifications, see [Cron trigger specifications in pipelines]({{site.baseurl}}/docs/integrations/codefresh-api/#cron-triggers).

Cron triggers are created in the UTC timezone.

If you see Cron triggers for your pipeline tagged with {::nomarkdown}<img src="../../../../images/icons/icon-warning.png" display=inline-block">{:/} tag, it indicates that you are using the legacy version.

file="/images/pipeline/triggers/cron/legacy-cron-trigger-tag.png"

url="/images/pipeline/triggers/cron/legacy-cron-trigger-tag.png"

caption="Legacy Cron trigger in Codefresh UI"

alt="Legacy Cron trigger in Codefresh UI"

max-width="60%"

%}

**Migrate legacy trigger**

* Click the **Edit** icon to view the trigger.

* To migrate, click **Convert**.

{% include image.html

lightbox="true"

file="/images/pipeline/triggers/cron/legacy-cron-convert.png"

url="/images/pipeline/triggers/cron/legacy-cron-convert.png"

caption="Migrate legacy Cron trigger in Codefresh UI"

alt="Migrate legacy Cron trigger in Codefresh UI"

max-width="60%"

%}

Codefresh migrates the legacy Cron trigger and displays a Trigger updated successfully message.

* Open the trigger displays the Settings tab with additional options.

{% include image.html

lightbox="true"

file="/images/pipeline/triggers/cron/legacy-cron-after-convert.png"

url="/images/pipeline/triggers/cron/legacy-cron-after-convert.png"

caption="Cron trigger after migration with Settings tab"

alt="Cron trigger after migration with Settings tab"

Create and manage Cron triggers for pipelines in the Codefresh UI.

There are two parts to creating a Cron trigger in the UI:

1. Defining the schedule for the trigger

To learn about supported `cron` expression formats and aliases, visit [this page](https://github.com/codefresh-io/cronus/blob/master/docs/expression.md){:target="\_blank"}.

1. (Optional) Selecting additional options:

* Git trigger event to simulate when the Cron trigger timer is activated. The pipeline is populated with the information from the Git repo such as the repo URL, branch name, latest commit information, including the date and author of the commit.

* Variables to populate for the build

* Caching, volume resuse and notification behavior to override for the build

>**NOTE**: Settings for Cron triggers is currently in Beta.

**Before you begin**

Review:

* [Git trigger settings]({{site.baseurl}}/docs/pipelines/triggers/git-triggers/#git-trigger-settings)

* [Working with Git triggers]({{site.baseurl}}/docs/pipelines/triggers/git-triggers/#working-with-git-triggers)

1. In the Codefresh UI, from the sidebar, select **Pipelines**.

1. Select the pipeline to which to add the trigger, and then click the **Workflow** tab.

1. On the right, click **Triggers**, and then click **Add Trigger**.

1. Click **Cron**, click **Next**.

file="/images/pipeline/triggers/add-trigger-dialog.png"

url="/images/pipeline/triggers/add-trigger-dialog.png"

caption="Select trigger type to add"

alt="Select trigger type to add"

max-width="60%"

{:start="5"}

1. In the **Cron Interval** tab, configure the schedule for the Cron trigger:

1. Select the time interval and the frequency at which to run the pipeline.

1. Use the info in the Expression Breakdown table to create a valid Cron **Expression**, or write a custom expression.

1. Add a free-text message to be sent as an additional event payload every time the Cron is executed.

{% include image.html

lightbox="true"

file="/images/pipeline/triggers/cron/cron-timer-tab.png"

url="/images/pipeline/triggers/cron/cron-timer-tab.png"

caption="Cron trigger: Cron Interval settings"

alt="Cron trigger: Cron Interval settings"

max-width="60%"

%}

{:start="6"}

1. Click **Settings**.

1. Define the Git trigger simulation options:

1. From the **Simulate Trigger From** drop-down list, select the type of Git trigger to simulate.

The list displays all the Git triggers defined for the pipeline.

1. From the **Select Branch** drop-down list, select the branch of the repository for this build.

1. Expand **Variables**, and add or modify [environment variables]({{site.baseurl}}/docs/pipelines/variables/) for this build.

1. Expand **Advanced Options** and select the overrides for this build. See [Advanced options]({{site.baseurl}}/docs/pipelines/triggers/git-triggers/#advanced-settings-for-git-triggers).

{% include image.html

lightbox="true"

file="/images/pipeline/triggers/cron/cron-settings-tab.png"

url="/images/pipeline/triggers/cron/cron-settings-tab.png"

caption="Cron trigger: Additional settings for Git event, variables, and build behavior"

alt="Cron trigger: Cron trigger: Additional settings for Git event, variables, and build behavior"

max-width="60%"

%}

{:start="7"}

1. To confirm click **Done**.

* If you defined only the Timer settings, the build is triggered according to the Cron expression.

* If you defined both the Timer and additional Settings, the build is triggered according to the Cron expression, and depending on the settings, the pipeline is populated with the information from the Git repo, additional variables, and notifications when configured.

To edit a Cron trigger after creating it, click the Edit icon.

This section is relevant only for legacy Cron triggers and will be deprecated.

You can also create and manage Cron triggers for pipelines via the [Codefresh CLI](https://cli.codefresh.io/){:target="\_blank"}.

Create a new `cron` trigger by defining a Cron expression and message.

To learn about supported `cron` expression formats and aliases, visit [this page](https://github.com/codefresh-io/cronus/blob/master/docs/expression.md){:target="\_blank"}.

The text message is passed to linked pipelines, whenever the specified `cron` timer is triggered.

{% highlight yaml %}

{% raw %}

{% endraw %}

{% endhighlight %}

{% highlight yaml %}

{% raw %}

codefresh create trigger "cron:codefresh:codefresh:0 */20 * * * *:hello-once-in-20-min:107e9db97062" 7a5622e4b1ad5ba0018a3c9c

{% endraw %}

{% endhighlight %}

From now on, Codefresh will trigger a pipeline execution for two pipelines linked to the previously specified `cron` `trigger-event`, every 20 minutes (`once in 20 minutes`).

The following variables are available to any Codefresh pipeline linked to a Cron trigger event:

- `EVENT_MESSAGE`: Free-text message (specified during creation)

- `EVENT_TIMESTAMP`: Event timestamp in RFC 3339 format

[Cron trigger specifications]({{site.baseurl}}/docs/integrations/codefresh-api/#cron-triggers)

[Variables in pipelines]({{site.baseurl}}/docs/pipelines/variables)