Skip to content

Commit e61ad98

Browse files
Merge branch 'main' into DOCSS-1930-unregistered-users
2 parents c55ff39 + 0eba5a5 commit e61ad98

30 files changed

+314
-294
lines changed

docs/guides/modules/ROOT/examples/logic-statement-examples/when-in-workflows/and-equal-dynamic.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
workflows:
22
nightly-run-workflow:
3-
# The "nightly-run-workflow" workflow only runs when the trigger is a scheduled pipeline AND the name of that trigger is "nightly_build"
3+
# The "nightly-run-workflow" workflow only runs when the trigger is scheduled AND the name of that trigger is "nightly_build"
44
when: pipeline.trigger_source == "scheduled_pipeline" and pipeline.schedule.name == "nightly_build"
55
jobs:
66
- build
114 KB
Loading

docs/guides/modules/ROOT/nav.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,18 +50,17 @@
5050
*** xref:orchestrate:github-trigger-event-options.adoc[GitHub trigger event options]
5151
*** xref:orchestrate:gitlab-trigger-options.adoc[GitLab trigger options]
5252
*** xref:orchestrate:custom-webhooks.adoc[Custom webhooks]
53-
** Schedule
54-
*** xref:orchestrate:scheduled-pipelines.adoc[Scheduled pipelines]
53+
*** xref:orchestrate:schedule-triggers.adoc[Schedule triggers]
5554
** How-to guides
5655
*** xref:orchestrate:orchestration-cookbook.adoc[Orchestration cookbook]
5756
*** xref:orchestrate:how-to-override-config.adoc[How to override config]
5857
*** xref:orchestrate:set-up-multiple-configuration-files-for-a-project.adoc[Set up multiple configuration files for a project]
5958
*** xref:orchestrate:notify-a-slack-channel-of-a-paused-workflow.adoc[Notify a Slack channel of a paused workflow]
6059
*** xref:orchestrate:using-branch-filters.adoc[Using branch filters]
6160
*** xref:orchestrate:selecting-a-workflow-to-run-using-pipeline-parameters.adoc[Select a workflow to run using pipeline parameters]
62-
*** xref:orchestrate:migrate-scheduled-workflows-to-scheduled-pipelines.adoc[Migrate scheduled workflows to scheduled pipelines]
63-
*** xref:orchestrate:schedule-pipelines-with-multiple-workflows.adoc[Schedule pipelines with multiple workflows]
64-
*** xref:orchestrate:set-a-nightly-scheduled-pipeline.adoc[Set a nightly scheduled pipeline]
61+
*** xref:orchestrate:migrate-scheduled-workflows-to-schedule-triggers.adoc[Migrate scheduled workflows to schedule triggers]
62+
*** xref:orchestrate:schedule-triggers-with-multiple-workflows.adoc[Schedule triggers with multiple workflows]
63+
*** xref:orchestrate:set-a-nightly-schedule-trigger.adoc[Set a nightly schedule trigger]
6564
*** xref:orchestrate:using-dynamic-configuration.adoc[Using dynamic configuration]
6665
*** xref:orchestrate:databases.adoc[Configure databases]
6766
*** xref:orchestrate:migrate-from-deploy-to-run.adoc[Migrate from deploy to run]
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
. In the link:https://app.circleci.com[CircleCI web app], select your org from the org cards on your user homepage.
22
. Select **Projects** from the sidebar and locate your project from the list. You can use the search to help.
33
. Select the ellipsis image:guides:ROOT:icons/more.svg[more icon, role="no-border"] next to your project and select **Project Settings**.
4+
+
5+
TIP: You can also access project settings from each project overview page using the btn:[Settings] button.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
[#can-i-migrate-existing-scheduled-workflows]
2+
=== Can I migrate existing scheduled workflows to schedule triggers?
3+
4+
Yes, visit the xref:guides:orchestrate:migrate-scheduled-workflows-to-schedule-triggers.adoc[Schedule triggers migration] guide for more information.
5+
6+
[#find-schedules-that-i-have-created]
7+
=== How do I find the schedules that I have created?
8+
9+
As schedule triggers are stored directly in CircleCI, there is a UUID associated with each schedule. You can view schedules that you have created on the **Triggers** page of the project settings. You can also list all the schedules under a single project:
10+
11+
```shell
12+
curl --location --request GET "https://circleci.com/api/v2/project/<project-slug>/schedule" \
13+
--header "circle-token: <PERSONAL_API_KEY>"
14+
```
15+
16+
Refer to the xref:guides:toolkit:api-developers-guide.adoc#getting-started-with-the-api[Getting started with the API] section of the API Developer's Guide for more guidance on making requests.
17+
18+
=== What time zone is used for schedule triggers?
19+
20+
Coordinated Universal Time (UTC) is the time zone in which schedules are interpreted.
21+
22+
[#pipelines-scheduled-to-run-specific-time-of-day]
23+
=== Can pipelines be scheduled to run at a specific time of day?
24+
25+
Yes, you can set up xref:guides:orchestrate:schedule-triggers.adoc[schedule triggers] through the xref:guides:orchestrate:schedule-triggers.adoc#get-started-with-schedule-triggers[CircleCI web app], or with xref:guides:orchestrate:schedule-triggers.adoc#use-the-api[CircleCI API v2].
26+
27+
If you are currently using xref:guides:orchestrate:workflows.adoc#scheduling-a-workflow[Scheduled workflows], see the xref:guides:orchestrate:migrate-scheduled-workflows-to-schedule-triggers.adoc[Migration guide] to update your scheduled workflows to schedule triggers.
28+
29+
=== Are schedule triggers guaranteed to run at precisely the time scheduled?
30+
31+
CircleCI provides no guarantees about precision. A random delay of up to 10 minutes is applied to the scheduled time (this delay can be up to one hour for schedule triggers created before September 29 2025). After the first run, the delay will be constant for all subsequent runs.
32+
33+
=== Why did my schedule trigger run later than expected?
34+
35+
Pipelines triggered via schedule are not guaranteed to run at exactly the specified time. For example, when you express the schedule as 1 per-hour for 08:00 UTC, the schedule trigger will run once within the 08:00 to 09:00 UTC window. Note that it means that it is unlikely to run at 08:00 UTC exactly.
36+
37+
However, subsequent runs of the schedule trigger will always be run on the same time as its previous run. In other words, if a previous schedule trigger ran at 08:11 UTC, the next runs should also be at 08:11 UTC.
38+
39+
=== Why can I not add a schedule trigger to my pipeline?
40+
41+
Only GitHub OAuth, GitHub App and Bitbucket Cloud pipelines support schedule triggers. GitLab and Bitbucket Data Center pipelines do not support schedule triggers. If you set up a schedule trigger through menu:Project Settings[Triggers] and do not see your pipeline in the "Pipeline to run" menu, check your pipeline type is supported .

docs/guides/modules/ROOT/partials/faq/scheduled-pipelines-faq-snip.adoc

Lines changed: 0 additions & 51 deletions
This file was deleted.

docs/guides/modules/ROOT/partials/pipelines-and-triggers/pipeline-values.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,15 +120,15 @@ d| [.nowrap]#GitHub App# +
120120
d| [.nowrap]#GitHub OAuth# +
121121
[.nowrap]#Bitbucket Cloud#
122122
| String
123-
| The name of the schedule if it is a scheduled pipeline. Value will be empty string if the pipeline is triggered by other sources.
123+
| The name of the schedule trigger if the pipeline was triggered via schedule. The value will be empty string if the pipeline is triggered by other sources.
124124
| [.circle-green]#**Yes**#
125125
| [.circle-green]#**Yes**#
126126

127127
| `pipeline.schedule.id`
128128
d| [.nowrap]#GitHub OAuth# +
129129
[.nowrap]#Bitbucket Cloud#
130130
| String
131-
| The unique id of the schedule if it is a scheduled pipeline. Value will be empty string if the pipeline is triggered by other sources.
131+
| The unique ID of the schedule if the pipeline was triggered via schedule trigger. Value will be empty string if the pipeline is triggered by other sources.
132132
| [.circle-green]#**Yes**#
133133
| [.circle-green]#**Yes**#
134134

docs/guides/modules/ROOT/partials/pipelines-and-triggers/scheduled-pipeline-setup.adoc

Lines changed: 0 additions & 19 deletions
This file was deleted.
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
[tabs]
2+
====
3+
GitHub App::
4+
+
5+
--
6+
include::ROOT:partial$app-navigation/steps-to-project-settings.adoc[]
7+
8+
. Select **Project Setup** in the sidebar.
9+
Locate your pipeline and select btn:[Schedule +].
10+
. Complete the schedule trigger form:
11+
+
12+
image::guides:ROOT:triggers/set-up-schedule-trigger.png[Schedule triggers web app form]
13+
** Give your trigger a descriptive name.
14+
** Select a branch to tell CircleCI which code to checkout and where to find your config file.
15+
** Under Pipeline attribution, select the actor to initiate the trigger. You can choose yourself, one of your team, or the scheduling system if you want the trigger to be independent from individual users. If your project requires the use of environment variables stored in restricted contexts, you should assign someone who has access to those contexts.
16+
** Enter any pipeline parameters that you would like to set when triggering the pipeline. If you enter any new pipeline parameters make sure to also add them to your config file. You can select btn:[Populate from config] to automatically populate the parameters fields from your config file.
17+
** Select a trigger frequency and repeat options.
18+
+
19+
[options="header",cols="1,2"]
20+
|===
21+
|Field |Options
22+
23+
|Repeats
24+
|Weekly, Monthly
25+
26+
|Days of the week
27+
| Radio buttons for each or select all
28+
29+
|Months
30+
| Radio buttons for each or select all
31+
32+
|Start time (UTC)
33+
| Radio buttons for each hour or select all
34+
35+
| Times per hour
36+
a|* 1 (once per hour)
37+
* 2 (every 30 minutes)
38+
* 3 (every 20 minutes)
39+
* 4 (every 15 minutes)
40+
* 5 (every 12 minutes)
41+
* 6 (every 10 minutes)
42+
* 7 (every 8.6 minutes)
43+
* 8 (every 7.5 minutes)
44+
* 9 (every 6.7 minutes)
45+
* 10 (every 6 minutes)
46+
* 11 (every 5.5 minutes)
47+
* 12 (every 5 minutes)
48+
|===
49+
50+
. Enable the trigger and select btn:[Save].
51+
--
52+
GitHub OAuth::
53+
+
54+
--
55+
include::ROOT:partial$app-navigation/steps-to-project-settings.adoc[]
56+
57+
. Select **Triggers** in the sidebar.
58+
. Select btn:[Add Trigger].
59+
+
60+
image::guides:ROOT:pipelines-scheduled-trigger-form.png[Schedule triggers web app form]
61+
** Give your trigger a descriptive name.
62+
** Enter an optional trigger description.
63+
** Select the pipeline to run.
64+
** Select a release frequencies (weekly/monthly, which days/months/time etc.).
65+
** Enter a branch or tag name to determine when to trigger the pipeline.
66+
** Optionally, enter pipeline parameters. If you declare pipeline parameters in the form, you need to make sure they are configured in your project's `.circleci/config.yml`. See the xref:guides:orchestrate:pipeline-variables.adoc#pipeline-parameters-in-configuration[Pipeline values and parameters] page for more information.
67+
** Select an actor to initiate the trigger.
68+
. Define the new schedule by filling out the form, then select **Save Trigger**.
69+
--
70+
Bitbucket Cloud::
71+
+
72+
--
73+
include::ROOT:partial$app-navigation/steps-to-project-settings.adoc[]
74+
75+
. Select **Triggers** in the sidebar.
76+
. Select btn:[Add Trigger].
77+
+
78+
image::guides:ROOT:pipelines-scheduled-trigger-form.png[Schedule triggers web app form]
79+
** Give your trigger a descriptive name.
80+
** Enter an optional trigger description.
81+
** Select the pipeline to run.
82+
** Select a release frequencies (weekly/monthly, which days/months/time etc.).
83+
** Enter a branch or tag name to determine when to trigger the pipeline.
84+
** Optionally, enter pipeline parameters. If you declare pipeline parameters in the form, you need to make sure they are configured in your project's `.circleci/config.yml`. See the xref:guides:orchestrate:pipeline-variables.adoc#pipeline-parameters-in-configuration[Pipeline values and parameters] page for more information.
85+
** Select an actor to initiate the trigger.
86+
. Define the new schedule by filling out the form, then select **Save Trigger**.
87+
--
88+
====

docs/guides/modules/ROOT/partials/troubleshoot/pipelines-troubleshoot-snip.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ config file .circleci/sample-filename.yml could not be located on branch sample-
1818

1919
If your scheduled pipeline is not running, verify the following things:
2020

21-
- Is the actor who is set for the scheduled pipelines still part of the organization? You can find this setting is under **Attribution** in the **Triggers** section of the web app.
22-
- Is the branch set for the schedule deleted?
21+
- Is the actor who is set for the schedule trigger still part of the organization? You can find this setting in the *Pipeline attribution* section for your trigger in the CircleCI web app.
22+
- Does the branch set for the trigger still exist?
2323
- Is your VCS organization using SAML protection? SAML tokens expire often, which can cause requests to fail.
2424
2525
[#jobs-not-running-when-push-commits]

0 commit comments

Comments
 (0)