{"id":18150852,"url":"https://github.com/yuri-val/auto-pr-description-action","last_synced_at":"2026-05-09T14:32:54.901Z","repository":{"id":259592352,"uuid":"878992859","full_name":"yuri-val/auto-pr-description-action","owner":"yuri-val","description":"GitHub Action is designed to make your life easier by automatically generating pull request (PR) descriptions.","archived":false,"fork":false,"pushed_at":"2024-11-08T13:54:06.000Z","size":371,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-13T05:29:39.539Z","etag":null,"topics":["description","diff","git","github","pull-request","review"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/auto-generate-pr-description","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yuri-val.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-10-26T17:04:57.000Z","updated_at":"2024-11-08T13:53:40.000Z","dependencies_parsed_at":"2024-12-20T11:28:03.473Z","dependency_job_id":"0cf3df6e-e857-44cb-b337-41ae5045d884","html_url":"https://github.com/yuri-val/auto-pr-description-action","commit_stats":null,"previous_names":["yuri-val/auto-pr-description-action"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuri-val%2Fauto-pr-description-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuri-val%2Fauto-pr-description-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuri-val%2Fauto-pr-description-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuri-val%2Fauto-pr-description-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yuri-val","download_url":"https://codeload.github.com/yuri-val/auto-pr-description-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247568010,"owners_count":20959714,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["description","diff","git","github","pull-request","review"],"created_at":"2024-11-02T01:05:40.355Z","updated_at":"2026-05-09T14:32:54.890Z","avatar_url":"https://github.com/yuri-val.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🤖 Auto-generate PR Description Action: Supercharge Your Pull Requests!\n\nThis GitHub Action leverages OpenAI's cutting-edge language models to automatically craft detailed, insightful pull request descriptions. Say goodbye to vague PR summaries and hello to clear, concise, and context-rich descriptions that enhance your team's collaboration and code review process.\n\n## 🚀 Features\n\n- Automatically generates detailed PR descriptions\n- Uses OpenAI's powerful language models\n- Customizable OpenAI model and temperature settings\n- Supports GitHub Actions workflow\n- Fetches diff content and commit messages for context\n\n\n## 📝 ToDo\n\n- [ ] Handles rate limiting and retries API calls\n- [ ] Configurable prompt templates for description generation\n- [ ] Supports multiple languages for generated descriptions\n\n## 📋 Requirements\n\n- GitHub repository\n- OpenAI API key\n\n## 🛠️ Installation\n\n1. Create a `.github/workflows/auto-pr-description.yml` file in your repository.\n2. Add the following content to the file:\n\n```yaml\nname: Auto-generate PR Description\non:\n  pull_request:\n    types: [opened, synchronize]\n\njobs:\n  generate-description:\n    runs-on: ubuntu-latest\n    permissions:\n      contents: read\n      pull-requests: write\n      issues: write\n    steps:\n      - uses: actions/checkout@v4\n      - name: Auto-generate PR Description\n        uses: yuri-val/auto-pr-description-action@v1\n        with:\n          openai_api_key: ${{ secrets.OPENAI_API_KEY }}\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n3. Add your OpenAI API key to your repository secrets as `OPENAI_API_KEY`.\n\n## ⚙️ Configuration\n\nYou can customize the action by providing the following inputs:\n\n| Input | Description | Required | Default |\n|-------|-------------|----------|---------|\n| `openai_api_key` | Your OpenAI API Key | Yes | N/A |\n| `openai_model` | OpenAI model to use (e.g., gpt-5.4-mini, gpt-4o) | No | gpt-5.4-mini |\n| `github_token` | GitHub token with repo permissions | Yes | ${{ github.token }} |\n| `temperature` | Sampling temperature for OpenAI (0.0 to 1.0) | No | 0.7 |\n\n## 📤 Outputs\n\nThe action provides the following outputs:\n\n- `pr_number`: The number of the pull request updated\n- `description`: The generated pull request description\n\n## 🤝 Contributing\n\nContributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/yuri-val/auto-pr-description-action/issues).\n\n## 📝 License\n\nThis project is [MIT](https://opensource.org/licenses/MIT) licensed.\n\n## 👤 Author\n\n**Yuri V**\n\n* GitHub: [@yuri-val](https://github.com/yuri-val)\n\n## 🙏 Acknowledgements\n\n- OpenAI for providing the powerful language models\n- GitHub Actions for the seamless integration\n\n---\n\nIf you find this action helpful, please consider giving it a ⭐️!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuri-val%2Fauto-pr-description-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyuri-val%2Fauto-pr-description-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuri-val%2Fauto-pr-description-action/lists"}