Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions docs/guides/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,17 @@
*** xref:orchestrate:github-trigger-event-options.adoc[GitHub trigger event options]
*** xref:orchestrate:gitlab-trigger-options.adoc[GitLab trigger options]
*** xref:orchestrate:custom-webhooks.adoc[Custom webhooks]
** Schedule
*** xref:orchestrate:scheduled-pipelines.adoc[Scheduled pipelines]
*** xref:orchestrate:schedule-triggers.adoc[Schedule triggers]
** How-to guides
*** xref:orchestrate:orchestration-cookbook.adoc[Orchestration cookbook]
*** xref:orchestrate:how-to-override-config.adoc[How to override config]
*** xref:orchestrate:set-up-multiple-configuration-files-for-a-project.adoc[Set up multiple configuration files for a project]
*** xref:orchestrate:notify-a-slack-channel-of-a-paused-workflow.adoc[Notify a Slack channel of a paused workflow]
*** xref:orchestrate:using-branch-filters.adoc[Using branch filters]
*** xref:orchestrate:selecting-a-workflow-to-run-using-pipeline-parameters.adoc[Select a workflow to run using pipeline parameters]
*** xref:orchestrate:migrate-scheduled-workflows-to-scheduled-pipelines.adoc[Migrate scheduled workflows to scheduled pipelines]
*** xref:orchestrate:schedule-pipelines-with-multiple-workflows.adoc[Schedule pipelines with multiple workflows]
*** xref:orchestrate:set-a-nightly-scheduled-pipeline.adoc[Set a nightly scheduled pipeline]
*** xref:orchestrate:migrate-scheduled-workflows-to-schedule-triggers.adoc[Migrate scheduled workflows to schedule triggers]
*** xref:orchestrate:schedule-triggers-with-multiple-workflows.adoc[Schedule triggers with multiple workflows]
*** xref:orchestrate:set-a-nightly-schedule-trigger.adoc[Set a nightly schedule trigger]
*** xref:orchestrate:using-dynamic-configuration.adoc[Using dynamic configuration]
*** xref:orchestrate:databases.adoc[Configure databases]
*** xref:orchestrate:migrate-from-deploy-to-run.adoc[Migrate from deploy to run]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
[#can-i-migrate-existing-scheduled-workflows]
=== Can I migrate existing scheduled workflows to schedule triggers?

Yes, visit the xref:guides:orchestrate:migrate-scheduled-workflows-to-schedule-triggers.adoc[Schedule triggers migration] guide for more information.

[#find-schedules-that-i-have-created]
=== How do I find the schedules that I have created?

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:

```shell
curl --location --request GET "https://circleci.com/api/v2/project/<project-slug>/schedule" \
--header "circle-token: <PERSONAL_API_KEY>"
```

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.

=== What time zone is used for schedule triggers?

Coordinated Universal Time (UTC) is the time zone in which schedules are interpreted.

[#pipelines-scheduled-to-run-specific-time-of-day]
=== Can pipelines be scheduled to run at a specific time of day?

Yes, you can set up xref:guides:orchestrate:schedule-triggers.adoc[schedule triggers] through the xref:guides:orchestrate:schedule-triggers.adoc#use-project-settings[CircleCI web app], or with xref:guides:orchestrate:schedule-triggers.adoc#use-the-api[CircleCI API v2].

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.

=== Are schedule triggers guaranteed to run at precisely the time scheduled?

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.

=== Why did my schedule trigger run later than expected?

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.

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.

=== Why can I not add a schedule trigger to my pipeline?

Only GitHub OAuth, GitHub App and Bitbucket Cloud pipelines support schedule triggers. If you try to set up a schedule trigger through the menu:Project Settings[Triggers] menu and do not see your pipeline in the "Pipeline to run" dropdown menu, it may be that you are trying to access an unsupported pipeline type (Gitlab or Bitbucket Data Center).

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -120,15 +120,15 @@ d| [.nowrap]#GitHub App# +
d| [.nowrap]#GitHub OAuth# +
[.nowrap]#Bitbucket Cloud#
| String
| The name of the schedule if it is a scheduled pipeline. Value will be empty string if the pipeline is triggered by other sources.
| 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.
| [.circle-green]#**Yes**#
| [.circle-green]#**Yes**#

| `pipeline.schedule.id`
d| [.nowrap]#GitHub OAuth# +
[.nowrap]#Bitbucket Cloud#
| String
| 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.
| 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.
| [.circle-green]#**Yes**#
| [.circle-green]#**Yes**#

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ config file .circleci/sample-filename.yml could not be located on branch sample-

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

- 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.
- Is the branch set for the schedule deleted?
- 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.
- Does the branch set for the trigger still exist?
- Is your VCS organization using SAML protection? SAML tokens expire often, which can cause requests to fail.

[#jobs-not-running-when-push-commits]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ The following settings are available in the project settings page. If you do not

**Groups**: Provides a list of user groups that have been granted project-specific permissions. For more information, see the xref:permissions-authentication:manage-groups.adoc[Manage groups] page.

**Project Setup**: Provides a list of GitHub pipelines that have been set up for the project and their associated triggers. See xref:orchestrate:pipelines.adoc[Pipelines Overview and Setup] for more information. Pipelines integrated with VCS different from GitHub are shown in the **Pipelines** tab. This page includes the option to create a first pipeline if none exist. The setup UI for scheduled pipelines is located here for GitHub pipelines or in the *Triggers* section for Bitbucket pipelines. To set up a xref:orchestrate:scheduled-pipelines.adoc[scheduled pipeline] you will define a timetable, parameter, and attribution to automatically run a pipeline when the criteria is met.
**Project Setup**: Provides a list of pipelines that have been set up for the project and their associated triggers. See xref:orchestrate:pipelines.adoc[Pipelines Overview and Setup] for more information. This page includes the option to begin setting up pipelines if none exist. The setup UI for scheduled pipelines is located either here or in the *Triggers* section (if available for your integration). To set up a xref:orchestrate:schedule-triggers.adoc[schedule trigger] you will define a timetable, parameter, and attribution to automatically run a pipeline when the criteria is met.

*Pipelines* and *Triggers*: These pages let you set up pipelines and triggers when using the GitLab, Bitbucket Cloud and Bitbucket Data Center integrations.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,10 +209,9 @@ You can only manage your connections between CircleCI and Bitbucket Data Center

Passing secrets to forked pull requests is not a currently supported option for Bitbucket Data Center integrations.

[#scheduled-pipelines]
=== Scheduled pipelines
=== Scheduled triggers

The ability to xref:orchestrate:scheduled-pipelines.adoc[schedule pipelines] is not currently supported for Bitbucket Data Center projects. This feature is planned for a future release.
The ability to xref:orchestrate:schedule-triggers.adoc[schedule triggers] is not currently supported for Bitbucket Data Center projects.

[#stop-building]
=== Stop building
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -183,11 +183,6 @@ The in-app config editor is currently **only** available for GitHub App accounts

Viewing menu:User settings[Account integrations] does not currently show a GitHub App integration. This page only shows GitHub OAuth app integrations.

[#scheduled-pipelines]
=== Scheduled pipelines

The ability to xref:orchestrate:scheduled-pipelines.adoc[schedule pipelines] is not yet supported for pipelines that use the GitHub App integration. This feature is planned for release by September 2025. As an alternative, use a xref:orchestrate:custom-webhooks.adoc[custom webhook] or the xref:orchestrate:triggers-overview.adoc#run-a-pipeline-using-the-api[V2 API to trigger a pipeline], which you can `curl` with a 3rd party scheduling tool.

[#build-forked-pull-requests]
=== Build forked pull requests

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -287,10 +287,9 @@ Currently, there is no method to manage the connection with GitLab outside of th

Passing secrets to forked pull requests is not a currently supported option for GitLab integrations.

[#scheduled-pipelines]
=== Scheduled pipelines
=== Schedule triggers

The ability to xref:orchestrate:scheduled-pipelines.adoc[schedule pipelines] is not currently supported for GitLab projects. This feature is planned for a future release.
The ability to xref:orchestrate:schedule-triggers.adoc[schedule triggers] is not currently supported for GitLab projects.

[#stop-building]
=== Stop building
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ _Used to trigger pipelines from any external system that can send HTTP requests_
* Event name and event source are user-defined.

*Schedules* +
Not supported yet, but coming soon. As an alternative, use custom webhooks with third-party scheduling tools.
_Used to trigger pipelines on a schedule (nightly builds for example)_
* Zero, one or many can be created per pipeline.

*API / Manual* +
GitHub App pipelines can be triggered via API and manually through the CircleCI web app.
Expand All @@ -138,7 +139,7 @@ The following table summarizes the trigger availability by pipeline type.

|GitHub App image:guides:ROOT:icons/github-app.svg[GitHub App pipeline badge, role="no-border"]
^|[.circle-red]#*No*#
^|[.circle-red]#*No*#
^|Zero, one, many
^|Zero, one, many
^|Zero, one, many
^|[.circle-green]#*Yes*#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@ include::ROOT:partial$tips/check-github-type.adoc[Check your GitHub integration
| [.circle-red]#**No**#
| [.circle-red]#**No**#

| xref:orchestrate:scheduled-pipelines.adoc[Scheduled pipelines]
| [.circle-red]#**No** ^1^#
| xref:orchestrate:schedule-triggers.adoc[Schedule triggers]
| [[.circle-green]#**Yes**#
| [.circle-red]#**No**#
| [.circle-red]#**No**#
| [.circle-green]#**Yes**#
Expand Down
Loading