diff --git a/docs/create-app.html b/docs/create-app.html new file mode 100644 index 0000000..05f74c8 --- /dev/null +++ b/docs/create-app.html @@ -0,0 +1,744 @@ + + + + + + Create Claude Code GitHub App + + + +
+
+

Create Your Custom GitHub App

+

+ Set up a custom GitHub App for Claude Code Action with all required + permissions automatically configured. +

+
+ + +
+
+ 🚀 +

Quick Setup

+
+

+ Create your GitHub App with one click. All permissions will be + automatically configured for Claude Code Action. +

+ +
+ +
+ +
+ + + +
+ +
+
+ + +
+ +
+
+ +
+ +
+
+
+ + +
+
+ ✅ +

Configured Permissions

+
+

+ Your GitHub App will be created with these permissions: +

+ +
+
+ ✓ + Contents + Read & Write +
+
+ ✓ + Issues + Read & Write +
+
+ ✓ + Pull Requests + Read & Write +
+
+ ✓ + Actions + Read +
+
+ ✓ + Metadata + Read +
+
+
+ + +
+
+ 📋 +

Next Steps

+
+

+ After creating your app, complete these steps: +

+ +
+
+
1
+
+

+ Generate a private key: In your app settings, + scroll to "Private keys" and click "Generate a private key" +

+
+
+
+
2
+
+

+ Install the app: Click "Install App" and select + the repositories where you want to use Claude +

+
+
+
+
3
+
+

+ Configure your workflow: Add your app's ID and + private key to your repository secrets +

+
+
+
+
+ + +
+
+ ⚙️ +

Manual Setup

+
+

+ If the buttons above don't work, you can manually create the app by + copying the manifest JSON below: +

+ +
+
+ github-app-manifest.json + +
+
+
+ +
+
+
1
+
+

Copy the manifest JSON above

+
+
+
+
2
+
+

+ Go to + GitHub App Settings +

+
+
+
+
3
+
+

Look for "Create from manifest" option and paste the JSON

+
+
+
+
+ + +
+ ⚠️ +
+ Important: Keep your private key secure! Never commit + it to your repository. Always use GitHub secrets to store sensitive + credentials. +
+
+
+ + + + diff --git a/docs/setup.md b/docs/setup.md index aed1090..2cfbd47 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -20,7 +20,48 @@ If you prefer not to install the official Claude app, you can create your own Gi - Organization policies prevent installing third-party apps - You're using AWS Bedrock or Google Vertex AI -**Steps to create and use a custom GitHub App:** +### Option 1: Quick Setup with App Manifest (Recommended) + +The fastest way to create a custom GitHub App is using our pre-configured manifest. This ensures all permissions are correctly set up with a single click. + +**Steps:** + +1. **Create the app:** + + **🚀 [Download the Quick Setup Tool](./create-app.html)** (Right-click → "Save Link As" or "Download Linked File") + + After downloading, open `create-app.html` in your web browser: + + - **For Personal Accounts:** Click the "Create App for Personal Account" button + - **For Organizations:** Enter your organization name and click "Create App for Organization" + + The tool will automatically configure all required permissions and submit the manifest. + + Alternatively, you can use the manifest file directly: + + - Use the [`github-app-manifest.json`](../github-app-manifest.json) file from this repository + - Visit https://github.com/settings/apps/new (for personal) or your organization's app settings + - Look for the "Create from manifest" option and paste the JSON content + +2. **Complete the creation flow:** + + - GitHub will show you a preview of the app configuration + - Confirm the app name (you can customize it) + - Click "Create GitHub App" + - The app will be created with all required permissions automatically configured + +3. **Generate and download a private key:** + + - After creating the app, you'll be redirected to the app settings + - Scroll down to "Private keys" + - Click "Generate a private key" + - Download the `.pem` file (keep this secure!) + +4. **Continue with installation** - Skip to step 3 in the manual setup below to install the app and configure your workflow. + +### Option 2: Manual Setup + +If you prefer to configure the app manually or need custom permissions: 1. **Create a new GitHub App:** diff --git a/github-app-manifest.json b/github-app-manifest.json new file mode 100644 index 0000000..e25c952 --- /dev/null +++ b/github-app-manifest.json @@ -0,0 +1,27 @@ +{ + "name": "Claude Code Custom App", + "description": "Custom GitHub App for Claude Code Action - AI-powered coding assistant for GitHub workflows", + "url": "https://github.com/anthropics/claude-code-action", + "hook_attributes": { + "url": "https://example.com/github/webhook", + "active": false + }, + "redirect_url": "https://github.com/settings/apps/new", + "callback_urls": [], + "setup_url": "https://github.com/anthropics/claude-code-action/blob/main/docs/setup.md", + "public": false, + "default_permissions": { + "contents": "write", + "issues": "write", + "pull_requests": "write", + "actions": "read", + "metadata": "read" + }, + "default_events": [ + "issue_comment", + "issues", + "pull_request", + "pull_request_review", + "pull_request_review_comment" + ] +}