Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitfc0b83f

Browse files
committed
Update cron triggers in pipeline specs
Added descriptions for all cron trigger params in pipeline specs
1 parentf35a838 commitfc0b83f

File tree

2 files changed

+44
-20
lines changed

2 files changed

+44
-20
lines changed

‎_docs/integrations/codefresh-api.md‎

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -430,7 +430,7 @@ externalResources:
430430

431431
###Git triggers
432432

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

435435
{: .table .table-bordered .table-hover}
436436
| Field name| Parent field| Type| Value|
@@ -519,23 +519,47 @@ triggers:
519519

520520
###Cron triggers
521521

522-
The`crontriggers` field is an array of objects that hold[Cron trigger information]({{site.baseurl}}/docs/pipelines/triggers/cron-triggers/) with the following fields.
522+
The`cronTriggers` field is an array of objects that hold[Cron trigger information]({{site.baseurl}}/docs/pipelines/triggers/cron-triggers/).
523523

524524
{: .table .table-bordered .table-hover}
525525
| Field name| Parent field| Type| Value|
526526
| --------------| ----------------------------|-------------------------| -------------------------|
527-
|`event`|`cronTriggers`|array|The Cron trigger event|
527+
|`event`|`cronTriggers`|string|Leave empty. Automatically generated by Codefresh for internal use.|
528528
|`name`|`cronTriggers`| string| The user-defined name for the Cron trigger.|
529-
|`message`|`cronTriggers`| string|The free-text message to be sent as an additional event payload every time the Cronjob isexecuted. For example,`Successful ingress-less`|
530-
|`expression`|`cronTriggers`| string|The Cron expression that defines the time and frequency of the Cronjob.For example,`0 3 * * 1-5` triggers the pipeline at`3:00 AM every weekday (Monday to Friday)`.|
531-
|`disabled`|`cronTriggers`| boolean| Determines if the Cron trigger isactivated. Whenset to`true`, triggerisnot activated. What is thedefault?|
532-
|`gitTriggerId`|`cronTriggers`| string| The ID of the Git trigger toactivate. From where do they git the trigger Id?|
533-
|`branch`|`cronTriggers`| string| The branch of the repo for which to simulate the Git trigger. For??|
534-
|`variables`|`cronTriggers`| array| The environment variables to populate for the pipeline???|
535-
|`options`|`cronTriggers`| string| ???|
529+
|`message`|`cronTriggers`| string|The free-text message to be sent as an additional event payload every time the Crontrigger isactivaed. For example,`Successful ingress tests`|
530+
|`expression`|`cronTriggers`| string|The Cron expression that defines the time and frequency of the Crontrigger.<br>For example,`0 3 * * 1-5`triggers the pipeline at_3:00 AM every weekday (Monday to Friday)_.|
531+
|`disabled`|`cronTriggers`| boolean| Determines if the Cron trigger isenabled for activation. <br>By default,set to`false` meaning that itisalways enabled. <br>To disable thetrigger, set to`true`.|
532+
|`gitTriggerId`|`cronTriggers`| string| The ID of the Git trigger tosimulate for the pipeline, retrieved from thepipeline for which it is defined.<br>To simulate a Gittrigger, the pipeline must have at least one Git trigger defined for it.<br>See[Git triggers](#git-triggers) in this article.|
533+
|`branch`|`cronTriggers`| string|Valid only when a Git trigger is simulated.<br>The branch of the repo for which to simulate the Git trigger and is automatically populated from the Git trigger ID.|
534+
|`variables`|`cronTriggers`| array|Valid only when a Git trigger is simulated.<br>The environment variables to populate for the pipeline when the Cron trigger is activated.|
535+
| `options` | `cronTriggers` | array | Valid only when a Git trigger is simulated.<br>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 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>{:/}|
536536

537-
example
538537

538+
`Pipeline Spec example for Cron triggers`
539+
{% highlight yaml %}
540+
{% raw %}
541+
...
542+
cronTriggers:
543+
- name:
544+
type: cron,
545+
message: "Successfull ingress tests"
546+
expression: "0 0/1 * 1/1 * *
547+
gitTriggerId: 64905de8589da959de81d31d
548+
branch: main
549+
variables:[]
550+
options:
551+
noCfCache: false
552+
noCache: false
553+
resetVolume: false
554+
enableNotifications: true
555+
disabled: true
556+
event: cron:codefresh:0 0/1 * 1/1 **:tests:ecef63b9ed20
557+
verified: true
558+
status: verified
559+
id: 64ddd8b04fdbcc74cc74fe80
560+
...
561+
{% endraw %}
562+
{% endhighlight %}
539563

540564
##Using Codefresh from within Codefresh
541565

‎_docs/pipelines/triggers/cron-triggers.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,17 @@ max-width="60%"
3636
%}
3737

3838

39-
Legacy Cron triggers in the UI are marked as ???. You can edit the trigger and update it
4039

4140
##Cron triggers in Codefresh UI
4241

43-
Create and manage Cron triggers for pipelines in the Codefresh UI.
44-
There are two parts to creating a Cron trigger:
42+
Create and manage Cron triggers for pipelines in the Codefresh UI.
43+
44+
There are two parts to creating a Cron trigger in the UI:
4545
1. Defining the schedule for the trigger
4646
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"}.
47-
1. Optional; defining the Git trigger event to simulate when the Cron trigger timer is activated.
48-
The Git trigger works the same way it does for the
47+
1. (Optional) selecting the Git trigger event to simulate when the Cron trigger timer is activated.
48+
Simulating a Git trigger has the same impact
49+
4950

5051

5152
###Create a Cron trigger in UI
@@ -91,7 +92,6 @@ max-width="60%"
9192
1. From the**Simulate Trigger From** drop-down list, select the type of Git trigger to simulate.
9293
The list displays all the Git triggers defined for the pipeline.
9394
1. From the**Select Branch** drop-down list, select the branch of the repository for this build.
94-
The branches corresponding to the repo for the selected Git trigger are displayed.
9595
1. Expand**Variables**, and add or modify[environment variables]({{site.baseurl}}/docs/pipelines/variables/) for this build.
9696
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).
9797

@@ -115,22 +115,22 @@ max-width="60%"
115115
Now you can Recurring pipeline executions are triggered according to the defined settings.
116116

117117
* If you defined only the Timer settings, the build is triggered according to the Cron expression.
118-
* If you defined both the Timer and Git Settings, the build is triggered according to the Cron expressionwhentheGit event is triggered atthe repo branch.
118+
* If you defined both the Timer and Git Settings, the build is triggered according to the Cron expressionand populated withtheinformation from the Git repo such astheGitrepoURL,branch name, latest commit information, including the date and author of the commit.
119119

120120
###Edit a Cron trigger in Codefresh UI
121121

122122
???
123123

124124
##Manage Cron triggers with Codefresh CLI
125125

126-
You can also create Cron triggers for pipelines via the[Codefresh CLI](https://cli.codefresh.io/){:target="\_blank"}.
126+
You can also createand manageCron triggers for pipelines via the[Codefresh CLI](https://cli.codefresh.io/){:target="\_blank"}.
127127

128128
You first create the Cron trigger and then set up a
129129

130130

131131
###Create Cron trigger event via CLI
132132

133-
Create a new`cron` triggerthrough a Cron expression and message.
133+
Create a new`cron` triggerby defining a Cron expression and message.
134134
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"}.
135135
The text message is passed to linked pipelines, whenever the specified`cron` timer is triggered.
136136

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp