{"id":41496746,"url":"https://github.com/augmentcode/describe-pr","last_synced_at":"2026-01-23T18:43:51.791Z","repository":{"id":308569046,"uuid":"1029428441","full_name":"augmentcode/describe-pr","owner":"augmentcode","description":"Let Auggie describe your PR for you","archived":false,"fork":false,"pushed_at":"2025-09-22T23:35:52.000Z","size":45,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-23T01:16:14.912Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.augmentcode.com","language":"Nunjucks","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/augmentcode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-31T03:30:33.000Z","updated_at":"2025-09-22T23:35:41.000Z","dependencies_parsed_at":"2025-08-06T17:48:59.022Z","dependency_job_id":"87a7c965-fedf-4581-9030-82b2e9f7509c","html_url":"https://github.com/augmentcode/describe-pr","commit_stats":null,"previous_names":["augmentcode/describe-pr"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/augmentcode/describe-pr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augmentcode%2Fdescribe-pr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augmentcode%2Fdescribe-pr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augmentcode%2Fdescribe-pr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augmentcode%2Fdescribe-pr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/augmentcode","download_url":"https://codeload.github.com/augmentcode/describe-pr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/augmentcode%2Fdescribe-pr/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28697734,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T17:25:48.045Z","status":"ssl_error","status_checked_at":"2026-01-23T17:25:47.153Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-23T18:43:51.108Z","updated_at":"2026-01-23T18:43:51.785Z","avatar_url":"https://github.com/augmentcode.png","language":"Nunjucks","readme":"# Auggie Describe PR GitHub Action\n\nAI-powered pull request descriptions using Auggie. This action automatically analyzes your PR changes and generates comprehensive, informative descriptions.\n\n## Quick Start\n\n### 1. Get Your Augment API Credentials\n\nFirst, you'll need to obtain your Augment Authentication information from your local Auggie session:\n\nExample session JSON:\n\n```json\n{\n  \"accessToken\": \"your-api-token-here\",\n  \"tenantURL\": \"https://your-tenant.api.augmentcode.com\"\n}\n```\n\nThere are 2 ways to get the credentials:\n\n- Run `auggie tokens print`\n  - Copy the JSON after `TOKEN=`\n- Copy the credentials stored in your Augment cache directory, defaulting to `~/.augment/session.json`\n\n\u003e **⚠️ Security Warning**: These tokens are OAuth tokens tied to your personal Augment account and provide access to your Augment services. They are not tied to a team or enterprise. Treat them as sensitive credentials:\n\u003e\n\u003e - Never commit them to version control\n\u003e - Only store them in secure locations (like GitHub secrets)\n\u003e - Don't share them in plain text or expose them in logs\n\u003e - If a token is compromised, immediately revoke it using `auggie tokens revoke`\n\n### 2. Set Up the GitHub Repository Secret\n\nYou need to add your Augment credentials to your GitHub repository:\n\n#### Adding Secret\n\n1. **Navigate to your repository** on GitHub\n2. **Go to Settings** → **Secrets and variables** → **Actions**\n3. **Add the following**:\n   - **Secret**: Click \"New repository secret\"\n     - Name: `AUGMENT_SESSION_AUTH`\n     - Value: The json value from step 1\n\n\u003e **Need more help?** For detailed instructions on managing GitHub secrets, see GitHub's official documentation:\n\u003e\n\u003e - [Using secrets in GitHub Actions](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions)\n\n### 3. Create Your Workflow File\n\nAdd a new workflow file to your repository's `.github/workflows/` directory and merge it.\n\n### Example Workflows\n\nFor complete workflow examples, see the [`example-workflows/`](./example-workflows/) directory which contains:\n\n- **[Basic PR Description](./example-workflows/basic-pr-description.yml)** - Simple setup for all new PRs\n- **[Draft PR Description](./example-workflows/draft-pr-description.yml)** - Only describe draft PRs\n- **[Feature Branch Description](./example-workflows/feature-branch-description.yml)** - Target specific branch patterns with labeling\n- **[Robust PR Description](./example-workflows/robust-pr-description.yml)** - Includes error handling and fallback notifications\n- **[On-Demand Description](./example-workflows/on-demand-description.yml)** - Triggered by adding the `auggie_describe` label\n- **[Simple Custom Guidelines](./example-workflows/simple-custom-guidelines.yml)** - Basic custom guidelines usage\n\nEach example includes a complete workflow file that you can copy to your `.github/workflows/` directory and customize for your needs.\n\n## Features\n\n- **Automatic PR Analysis**: Analyzes code changes, file modifications, and diff content\n- **Intelligent Descriptions**: Generates comprehensive PR descriptions using AI\n- **Context-Aware**: Understands your codebase structure and change patterns\n- **GitHub Integration**: Seamlessly updates PR descriptions via GitHub API\n\n## Inputs\n\n| Input                  | Description                                           | Required | Example                                             |\n| ---------------------- | ----------------------------------------------------- | -------- | --------------------------------------------------- |\n| `augment_session_auth` | Augment session authentication JSON (store as secret) | Yes      | `${{ secrets.AUGMENT_SESSION_AUTH }}`               |\n| `github_token`         | GitHub token with `repo` scopes                       | Yes      | `${{ secrets.GITHUB_TOKEN }}`                       |\n| `pull_number`          | The number of the pull request being described        | Yes      | `${{ github.event.pull_request.number }}`           |\n| `repo_name`            | The full name (owner/repo) of the repository          | Yes      | `${{ github.repository }}`                          |\n| `custom_guidelines`    | Custom guidelines for PR descriptions (optional)      | No       | See [Custom Guidelines](#custom-guidelines) section |\n| `model`                | Optional model to use for generation                  | No       | e.g. `sonnet4`, from `auggie --list-models`         |\n| `rules`                | JSON array of rules file paths forwarded to agent     | No       | `[\".augment/rules.md\"]`                             |\n| `mcp_configs`          | JSON array of MCP config paths forwarded to agent     | No       | `[\".augment/mcp.md\"]`                               |\n| `fetch_depth`          | Optional fetch depth for git checkout (default: 0)    | No       | `10` for shallow clones, `0` for full history       |\n\n## How It Works\n\n1. **Checkout**: Checks out the PR head to access the complete codebase\n2. **Data Gathering**: Fetches PR metadata, changed files, and diff content from GitHub API\n3. **Template Rendering**: Uses Nunjucks templates to create a structured instruction for the AI\n4. **AI Processing**: Calls the Augment Agent to analyze the changes and generate a description\n5. **PR Update**: The Augment Agent updates the PR description with the generated content\n\n## Performance Optimization\n\nFor large repositories with long history, you can use the `fetch_depth` parameter to speed up checkouts by limiting the git history fetched:\n\n```yaml\n- name: Generate PR Description\n  uses: augmentcode/describe-pr@v0\n  with:\n    # ... other inputs ...\n    fetch_depth: 50 # Only fetch last 50 commits\n```\n\nThis can significantly reduce checkout time for repositories with extensive history while still providing enough context for PR description generation.\n\n## Custom Guidelines\n\nYou can add project-specific guidelines to any workflow by including the `custom_guidelines` input:\n\n```yaml\n- name: Generate PR Description\n  uses: augmentcode/describe-pr@v0\n  with:\n    # ... other inputs ...\n    custom_guidelines: |\n      - Always mention if database migrations are included\n      - Highlight any breaking API changes\n      - Reference the Jira ticket number if applicable\n      - Include performance impact for large changes\n```\n\n## Permissions\n\nThe action requires the following GitHub token permissions:\n\n```yaml\npermissions:\n  contents: read # To checkout the repository and read files\n  pull-requests: write # To update PR descriptions\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faugmentcode%2Fdescribe-pr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faugmentcode%2Fdescribe-pr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faugmentcode%2Fdescribe-pr/lists"}