diff --git a/sources/platform/integrations/images/apify-git-provider-select.png b/sources/platform/integrations/images/apify-git-provider-select.png deleted file mode 100644 index 42c6a6941b..0000000000 Binary files a/sources/platform/integrations/images/apify-git-provider-select.png and /dev/null differ diff --git a/sources/platform/integrations/images/apify-git-repository.png b/sources/platform/integrations/images/apify-git-repository.png index f1a528c427..08b8b1323d 100644 Binary files a/sources/platform/integrations/images/apify-git-repository.png and b/sources/platform/integrations/images/apify-git-repository.png differ diff --git a/sources/platform/integrations/images/integrations-tab.png b/sources/platform/integrations/images/integrations-tab.png index 4e39107b61..67539a4f3f 100644 Binary files a/sources/platform/integrations/images/integrations-tab.png and b/sources/platform/integrations/images/integrations-tab.png differ diff --git a/sources/platform/integrations/programming/github.md b/sources/platform/integrations/programming/github.md index b22b9fe2e4..f1b6322f56 100644 --- a/sources/platform/integrations/programming/github.md +++ b/sources/platform/integrations/programming/github.md @@ -1,43 +1,157 @@ --- title: GitHub integration -description: Learn how to integrate your Apify Actors with GitHub. This article shows you how to automatically create an issue in your repo when an Actor run fails. +description: Connect Apify with GitHub to build Actors from a repository, rebuild on every push, and create issues automatically when an Actor run fails. sidebar_label: GitHub sidebar_position: 3 slug: /integrations/github --- -## Get started +import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; -To use the Apify integration for GitHub, you will need: +With the Apify integration for [GitHub](https://github.com/), you can create an Actor from a public or private repository, rebuild it automatically on every push, and trigger workflows in your repo when an Actor run fails, succeeds, or times out. To run automated tests and multi-branch builds with GitHub Actions, see [Continuous integration for Actors](/platform/actors/development/deployment/continuous-integration). + + + +## Prerequisites + +To use the GitHub integration, you need: - An [Apify account](https://console.apify.com/). -- A GitHub repository. +- A GitHub account with access to the repository you want to link. + +## Create an Actor from a GitHub repository + +Follow these steps to build a new Actor from code hosted on GitHub. + +### Step 1: Open the new Actor page + +In [Apify Console](https://console.apify.com/actors), go to **Actors** and click **Develop new**. + +![Let's build a new Actor page in Apify Console](../images/apify-git-repository.png) + +### Step 2: Connect your GitHub account + +Under **Link a Git repository**, click **GitHub**. Follow the prompts on github.com to authorize Apify. You can grant access to your personal account, an organization, or specific repositories. + +![Authorize Apify on GitHub](../images/apify-git-repository-add.png) + +To switch between authorized users and organizations, use the account dropdown. + +![Account picker](../images/apify-git-repository-account.png) + +### Step 3: Select a repository + +Pick the repository you want to link. If you don't see it, use the **Search** field to find it by name. + +![Repository search](../images/apify-git-repository-search.png) + +Apify creates the Actor as soon as you select a repository, links its source to the repository, and uses the default branch unless you change it in the Actor's **Source** settings. + +:::tip Private repositories + +For private repositories, configure a [deployment key](/platform/actors/development/deployment/source-types#private-repositories) so Apify can clone the code. + +::: + +## Build automatically on every push + +{/* REVIEWER QUESTION: The "Link a Git repository" panel says "set Apify to automatically build the Actor on changes", which suggests the native GitHub flow above already wires up auto-builds on push. If so, the manual GitHub webhook recipe below is now the legacy/advanced path. Please confirm the current behavior and let me know whether to (a) keep the manual recipe as-is, (b) replace it with a one-line note + link to CI for Actors, or (c) keep both with a short "the flow above already triggers builds; use this for finer control" intro. */} -### Create an Actor from a GitHub repository +After you link an Actor to a GitHub repository, add a webhook in GitHub to trigger a new build on every push: -Learn how to create an Actor from a GitHub repository. This is useful if you want to automatically deploy and build your code or push to your GitHub repository. +1. In Apify Console, open the Actor's **API** tab and select **API Endpoints**. Copy the **Build Actor** endpoint URL. It has this format: -![New Actor page](../images/apify-git-repository.png) + ```text + https://api.apify.com/v2/acts/YOUR-ACTOR-NAME/builds?token=YOUR-TOKEN&version=0.0&tag=latest&waitForFinish=60 + ``` -Selecting _Link Git repository_ will open a new modal to select a provider to use. -Selecting _GitHub_ will open a new window with GitHub authentication and select a GitHub repository. + :::note API token -![Git provider select modal](../images/apify-git-provider-select.png) + Select the correct API token in the dropdown before copying the URL. -To link an account, click on _Add GitHub account_ and follow the instructions on github.com. Certain organizations or users can be selected. + ::: -![Git repository account select](../images/apify-git-repository-add.png) +1. In the GitHub repository, go to **Settings > Webhooks > Add webhook**. +1. Paste the URL into **Payload URL**, set **Content type** to `application/json`, and save. -You can switch among all authorized users and organizations. +Every push to the repository now triggers a build of the linked Actor version. -![Git repository account select](../images/apify-git-repository-account.png) +For automated tests and multi-branch workflows (for example, separate `latest` and `beta` tags), follow the [Continuous integration for Actors](/platform/actors/development/deployment/continuous-integration) guide. -If the required repository is missing, try finding it with _Search_. +## Create a GitHub issue when an Actor run fails -![apify-git-repository-search.png](../images/apify-git-repository-search.png) +Use an Apify webhook to call the GitHub REST API and open an issue in your repository whenever an Actor run finishes with the `FAILED` status. This lets you triage failures in the same place you track other work. -An Actor is created immediately from the selected repository. +### Prerequisites -### Create an issue when a run fails +- An Apify Actor you can run. +- A GitHub repository where the issues are created. +- A [GitHub fine-grained personal access token](https://github.com/settings/personal-access-tokens) with **Issues: Read and write** permission scoped to the target repository. + +### Step 1: Generate a GitHub personal access token + +1. In GitHub, open **Settings > Developer settings > Personal access tokens > Fine-grained tokens** and click **Generate new token**. +1. Set **Repository access** to **Only select repositories** and pick the repository where you want issues to be created. +1. Under **Repository permissions**, set **Issues** to **Read and write**. +1. Generate the token and copy it. You'll paste it into the webhook headers in Step 3. + +:::warning Treat the token as a secret + +Anyone with this token can create issues in the selected repository. Don't commit it or share it in screenshots. + +::: + +### Step 2: Add a webhook on the Actor + +1. In Apify Console, open the Actor and go to the **Integrations** tab. + + ![Add integration page on an Actor's Integrations tab](../images/integrations-tab.png) + +1. Under **Connect with Apify**, click **HTTP webhook**. +1. Configure the webhook: + - **Event types**: select `Run failed` (`ACTOR.RUN.FAILED`). + - **URL**: `https://api.github.com/repos/OWNER/REPO/issues`, replacing `OWNER` and `REPO` with your repository details. + +### Step 3: Set the headers and payload + +In the same webhook form, configure the request that GitHub expects. + +Set **Headers template** to authenticate with the personal access token and tell GitHub which API version to use: + +```json +{ + "Authorization": "Bearer YOUR_GITHUB_TOKEN", + "Accept": "application/vnd.github+json", + "X-GitHub-Api-Version": "2022-11-28" +} +``` + +Enable **Interpolate variables in string fields**, then set **Payload template** so the issue title and body include the failed run details: + +```json +{ + "title": "Actor run {{resource.id}} failed", + "body": "Actor [{{resource.actId}}](https://console.apify.com/actors/{{resource.actId}}) finished with status `{{resource.status}}`.\n\nRun: https://console.apify.com/actors/{{resource.actId}}/runs/{{resource.id}}\nStarted: {{resource.startedAt}}\nFinished: {{resource.finishedAt}}\nExit code: {{resource.exitCode}}", + "labels": ["actor-failure"] +} +``` + +For the full list of variables you can use, see [Webhook actions](/platform/integrations/webhooks/actions#available-variables). + +### Step 4: Save and test the webhook + +1. Click **Save** to add the webhook. +1. Click **Test** to send a sample payload to the GitHub API. Verify a new issue appears in the repository. +1. Trigger a real failure (for example, by aborting a run that's configured to fail or by running the Actor with invalid input) and confirm an issue is created. + +If the test fails, check the webhook **Dispatches** log for the response from GitHub. Common causes are an expired token, missing repository permissions, or a typo in the repository path. + +### Video walkthrough + +## Resources + +- [Source types for Actors](/platform/actors/development/deployment/source-types) - Configure the Git URL, branch, and monorepo paths. +- [Continuous integration for Actors](/platform/actors/development/deployment/continuous-integration) - Run tests and trigger builds with GitHub Actions. +- [Webhook events](/platform/integrations/webhooks/events) and [actions](/platform/integrations/webhooks/actions) - Reference for available events and the payload template.