docs: deploying using the github integration (#2598)

* docs: deploying using the github integration

* Add hint in the gh actions docs page

* Remove extra space

* Add a couple of hints to the build config fields

Author: myftija

apps/webapp/app/routes/_app.github.callback/route.tsx

@@ -37,7 +37,7 @@ export async function loader({ request }: LoaderFunctionArgs) {
     logger.warn("GitHub App callback with invalid params", {
       queryParams,
     });
-    return redirectWithErrorMessage("/", request, "Failed to install GitHub App");
+    return redirectWithErrorMessage("/", request, "Failed to install GitHub app");
   }
 
   const callbackData = result.data;
@@ -50,7 +50,7 @@ export async function loader({ request }: LoaderFunctionArgs) {
       error: sessionResult.error,
     });
 
-    return redirectWithErrorMessage("/", request, "Failed to install GitHub App");
+    return redirectWithErrorMessage("/", request, "Failed to install GitHub app");
   }
 
   const { organizationId, redirectTo: unsafeRedirectTo } = sessionResult;
@@ -72,7 +72,7 @@ export async function loader({ request }: LoaderFunctionArgs) {
       userId: user.id,
       organizationId,
     });
-    return redirectWithErrorMessage(redirectTo, request, "Failed to install GitHub App");
+    return redirectWithErrorMessage(redirectTo, request, "Failed to install GitHub app");
   }
 
   switch (callbackData.setup_action) {
@@ -85,7 +85,7 @@ export async function loader({ request }: LoaderFunctionArgs) {
         logger.error("Failed to link GitHub App installation", {
           error,
         });
-        return redirectWithErrorMessage(redirectTo, request, "Failed to install GitHub App");
+        return redirectWithErrorMessage(redirectTo, request, "Failed to install GitHub app");
       }
 
       return redirectWithSuccessMessage(redirectTo, request, "GitHub App installed successfully");
@@ -116,6 +116,6 @@ export async function loader({ request }: LoaderFunctionArgs) {
 
     default:
       callbackData satisfies never;
-      return redirectWithErrorMessage(redirectTo, request, "Failed to install GitHub App");
+      return redirectWithErrorMessage(redirectTo, request, "Failed to install GitHub app");
   }
 }

docs/deployment/connect-repo.png

@@ -111,7 +111,7 @@
               "deployment/atomic-deployment",
               {
                 "group": "Deployment integrations",
-                "pages": ["vercel-integration"]
+                "pages": ["github-integration", "vercel-integration"]
               }
             ]
           },

docs/deployment/git-settings.png

@@ -5,6 +5,10 @@ description: "You can easily deploy your tasks with GitHub actions and other CI
 
 The instructions below are specific to GitHub Actions, but the same concepts can be used with other CI systems.
 
+<Tip>
+  Check out our new [GitHub integration](/github-integration) for automatic deployments, without adding any GitHub Actions workflows.
+</Tip>
+
 ## GitHub Actions example
 
 This simple GitHub action workflow will deploy your Trigger.dev tasks when new code is pushed to the `main` branch and the `trigger` directory has changes in it.

docs/docs.json

@@ -0,0 +1,132 @@
+---
+title: "GitHub integration"
+description: "Automatically deploy your tasks on every push to your GitHub repository."
+---
+
+## How it works
+
+Once you connect a GitHub repository to your project, you can configure tracking branches for the production and staging environments.
+Every push to a tracked branch creates a deployment in the corresponding environment. Preview branch deployments are also supported for pull requests.
+
+This eliminates the need to manually run the `trigger.dev deploy` command or set up custom CI/CD workflows.
+
+## Setup
+
+<Steps>
+
+<Step title="Install our GitHub app">
+  Go to your project's settings page and click `Install GitHub app`.
+  This will take you to GitHub to authorize the Trigger.dev app for your organization or personal account.
+</Step>
+
+<Step title="Connect your repository">
+  Select a repository to connect to your project.
+</Step>
+
+<Step title="Configure branch tracking">
+  Choose which branches should trigger automatic deployments:
+
+  - **Production**: The branch that deploys to your production environment, e.g., `main`.
+  - **Staging**: The branch that deploys to your staging environment.
+  - **Preview**: Toggle to enable preview deployments for pull requests
+</Step>
+
+<Step title="Customize build settings (optional)">
+  Configure how your project is built:
+
+  - **Trigger config file**: Path to your `trigger.config.ts` file. By default, we look for it in the root of your repository. The path should be relative to the root of your repository and contain the config file name, e.g., `apps/tasks/trigger.config.ts`.
+  - **Install command**: Auto-detected by default, but you can override it if necessary. The command will be run from the root of your repository.
+  - **Pre-build command**: Run any commands before building and deploying your project, e.g., `pnpm run prisma:generate`. The command will be run from the root of your repository.
+</Step>
+
+</Steps>
+
+## Branch tracking
+
+Our GitHub integration uses branch tracking to determine when and where to deploy your code.
+
+![Trigger.dev project git settings](/deployment/git-settings.png)
+
+### Production and staging branches
+
+When you connect a repository, the default branch of your repository will be used as the production tracking branch, by default.
+
+When you configure a production or staging branch, every push to that branch will trigger a deployment.
+Our build server will install the project dependencies, build your project, and deploy it to the corresponding environment.
+
+If there are multiple consecutive pushes to a tracked branch, the later deployments will be queued until the previous deployment completes.
+
+<Note>
+  When you connect a repository, the default branch of your repository will be used as the production tracking branch by default.
+  You can change this in the git settings of your project.
+</Note>
+
+### Pull requests
+
+By default, pull requests will be deployed to preview branch environments, enabling you to test changes before merging.
+When the pull request is merged or closed, the preview branch is automatically archived.
+
+The name of the preview branch matches the branch name of the pull request.
+
+<Note>
+  Preview branch deployments require the preview environment to be enabled on your project. Learn more about [preview branches](/deployment/preview-branches).
+</Note>
+
+## Disconnecting a repository
+
+You can disconnect a repository at any time from your project git settings. This will stop automatic deployments triggered from GitHub.
+
+## Managing repository access
+
+To add or remove repository access for the Trigger.dev GitHub app, follow the link in the `Connect GitHub repository` modal:
+
+![Trigger.dev prompt to connect a GitHub repository](/deployment/connect-repo.png)
+
+Alternatively, you can follow these steps on GitHub:
+
+1. Go to your GitHub account settings
+2. Navigate to **Settings** → **Applications** → **Installed GitHub Apps**
+3. Click **Configure** next to `Trigger.dev App`
+4. Update repository access under `Repository access`
+
+Changes to repository access will be reflected immediately in your Trigger.dev project settings.
+
+## Environment variables at build time
+
+You can expose environment variables during the build and deployment process by prefixing them with `TRIGGER_BUILD_`.
+Build extensions will also have access to these variables.
+
+Build environment variables only apply to deployments in the environment you set them in.
+
+Learn more about managing [environment variables](/deploy-environment-variables).
+
+## Using a private npm registry
+
+If your project uses packages from a private npm registry, you can provide authentication by setting a `TRIGGER_BUILD_NPM_RC` environment variable.
+
+The value should be the contents of your `.npmrc` file including any token credentials, encoded to base64.
+
+### Example
+
+Example `.npmrc` file containing credentials for a private npm registry and a GitHub package registry:
+
+```
+//registry.npmjs.org/:_authToken=<YOUR_NPM_TOKEN>
+@<YOUR_NAMESPACE>:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:always-auth=true
+//npm.pkg.github.com/:_authToken=<YOUR_GITHUB_TOKEN>
+```
+
+Encode it to base64:
+
+```bash
+# Encode your .npmrc file
+cat .npmrc | base64
+```
+
+Then, set the `TRIGGER_BUILD_NPM_RC` environment variable in your project settings with the encoded value.
+
+<Note>
+  The build server will automatically create a `.npmrc` file in the installation directory based on the content of the `TRIGGER_BUILD_NPM_RC` environment variable.
+  This enables the build server to authenticate to your private npm registry.
+</Note>