Skip to content

Commit 8e74e04

Browse files
authored
Add manifest for creating custom app (#31)
add manifest for custom app <!-- Thank you for proposing a pull request! Please note that SOME TESTS WILL LIKELY FAIL due to how GitHub exposes secrets in Pull Requests from forks. Someone from the team will review your Pull Request and respond. Please describe your change and any implementation details below. -->
1 parent 4a191e6 commit 8e74e04

2 files changed

Lines changed: 25 additions & 0 deletions

File tree

custom_app_manifest.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# GitHub App Manifest
2+
# This manifest provides the initial configuration for your GitHub App.
3+
# You will paste this into the "Create GitHub App" page on GitHub.
4+
5+
# General App Information
6+
name: '<NAME>-gemini-cli' # Required: A unique name for your application. Max 39 characters.
7+
description: 'A custom GitHub App to run Gemini CLI.' # Optional: A brief description of your app's purpose.
8+
homepage_url: 'https://example.com' # Required: The URL to your app's homepage or landing page.
9+
10+
# Permissions
11+
# Define the access your app needs to GitHub resources.
12+
# Permissions are granular and should follow the principle of least privilege.
13+
# Refer to the GitHub documentation for a complete list of permissions:
14+
# https://docs.github.com/en/rest/overview/permissions-required-for-github-apps
15+
permissions:
16+
contents: 'write' # Example: Allows your app to read and write to repository contents (files, commits, branches).
17+
issues: 'write' # Example: Allows your app to read and create/update issues.
18+
pull_requests: 'write' # Example: Allows your app to read and create/update pull requests.
19+
20+
restrict_installation_to_owner: false # Optional: If true, only the app owner can install the app on their repositories/organizations. Defaults to false.
21+
22+
hook_attributes:
23+
- active: false

docs/github-app.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ For optimal security and control, we strongly recommend creating a custom GitHub
3333
> **Note:** Always adhere to the principle of least privilege. If your custom workflows require fewer permissions, adjust these settings accordingly.
3434
5. Click **Create GitHub App**.
3535

36+
A manifest is also available at `custom_app_manifest.yml`. For details on registering a GitHub App from a manifest, see the [GitHub documentation](https://docs.github.com/en/apps/sharing-github-apps/registering-a-github-app-from-a-manifest).
37+
3638
### Step 2: Generate a Private Key and Get the App ID
3739

3840
1. After your app is created, you will be returned to its settings page. Click **Generate a private key**.

0 commit comments

Comments
 (0)