Skip to content

using-automations.md

Latest commit

 

History

History
63 lines (45 loc) · 5.71 KB

using-automations.md

File metadata and controls

63 lines (45 loc) · 5.71 KB
Raw
title Using automations in the GitHub Copilot app
shortTitle Automations
intro Automate recurring agent tasks so they run on a schedule or on demand, without manual intervention.
allowTitleToDifferFromFilename true
product {% data reusables.gated-features.github-app %}<br><a href="https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=button&utm_source=docs-automations-signup&utm_medium=docs&utm_campaign=github-copilot-app-ga-2026" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Sign up for {% data variables.product.prodname_copilot_short %}</span> {% octicon "link-external" height:16 %}</a>
versions
feature
copilot
contentType how-tos
redirect_from
/copilot/how-tos/github-copilot-app/using-scheduled-workflows
/copilot/how-tos/github-app/using-scheduled-workflows
category
Author and optimize with Copilot

About {% data variables.copilot.copilot_automations %}

{% data variables.copilot.copilot_automations_cap %} let you save recurring agent tasks and run them on a schedule or on demand. For example, you can create an {% data variables.copilot.copilot_automation %} that triages new issues daily or checks your open pull requests for review status each morning.

You can create and manage {% data variables.copilot.copilot_automations %} from:

  • The Agents tab in a repository on {% data variables.product.github %}, in the {% data variables.copilot.copilot_automations_cap %} pane.
  • The {% data variables.copilot.copilot_automations_cap %} tab in the {% data variables.copilot.github_copilot_app %}.

For an overview of {% data variables.copilot.copilot_automations %}, including triggers, tools, visibility, and security, see AUTOTITLE.

The {% data variables.copilot.github_copilot_app %} supports two types of {% data variables.copilot.copilot_automations %}:

  • Local {% data variables.copilot.copilot_automations %}, which run from your local environment.
  • Cloud {% data variables.copilot.copilot_automations %}, which run in a cloud environment.

Click Automations in the sidebar to see your saved {% data variables.copilot.copilot_automations %}. Each {% data variables.copilot.copilot_automation %} shows its name, schedule, associated repository, and last run status.

Prerequisites for using cloud {% data variables.copilot.copilot_automations %}

To use cloud {% data variables.copilot.copilot_automations %}, make sure the following settings are enabled.

  • {% data variables.copilot.copilot_cloud_agent %} must be enabled for the repository. If you have {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %}, an administrator must enable the {% data variables.copilot.copilot_cloud_agent %} policy. See AUTOTITLE.
  • The organization must allow both {% data variables.copilot.copilot_cloud_agent %} and {% data variables.copilot.copilot_automations %} in the repository (both are enabled by default). See AUTOTITLE.
  • If you want to create {% data variables.copilot.copilot_automations %} that can listen to events triggered by users without write access, disable the "Only allow automations to be triggered by users with write access" setting in {% data variables.copilot.copilot_cloud_agent %} repository settings.

Creating an {% data variables.copilot.copilot_automation %}

  1. Click New automation in the top-right corner.

  2. Enter a name for the {% data variables.copilot.copilot_automation %}.

  3. Select one or more triggers that determine when the {% data variables.copilot.copilot_automation %} runs:

    • Manual: Run the {% data variables.copilot.copilot_automation %} manually.
    • On a schedule: choose a recurring interval, either hourly, daily, or weekly.
    • When an issue is created: the {% data variables.copilot.copilot_automation %} runs each time an issue is opened in the repository. You can add a search query filter for specific issues.

  4. Optionally, enable Run in the cloud to let the {% data variables.copilot.copilot_automation %} run in a cloud environment, allowing the {% data variables.copilot.copilot_automation %} to run even when your computer is off.

    For cloud {% data variables.copilot.copilot_automations %}, you can also use the Tools dropdown to select the tools {% data variables.product.prodname_copilot_short %} can use when the automation runs, such as pushing changes, updating issue labels, or creating a pull request. Select only the tools the task requires. The tools you select control what actions {% data variables.product.prodname_copilot_short %} can take in your repository.

  5. In the prompt field, describe the task you want {% data variables.product.prodname_copilot_short %} to perform each time the {% data variables.copilot.copilot_automation %} runs.

  6. Optionally, select the project and model you want {% data variables.product.prodname_copilot_short %} to use.

  7. Click Create to save, or select Create and run to save and test the {% data variables.copilot.copilot_automation %} immediately.

Running an {% data variables.copilot.copilot_automation %} on demand

You can trigger any saved {% data variables.copilot.copilot_automation %} manually by clicking the play button on its card on the "Automations" page, without waiting for its next scheduled run.

You can also open {% data variables.copilot.copilot_automations %} directly in the app using deep links from markdown files, third-party tools, or scripts. For more information, see AUTOTITLE.