https://github.com/yuri-val/auto-pr-description-action
GitHub Action is designed to make your life easier by automatically generating pull request (PR) descriptions.
https://github.com/yuri-val/auto-pr-description-action
description diff git github pull-request review
Last synced: about 2 months ago
JSON representation
GitHub Action is designed to make your life easier by automatically generating pull request (PR) descriptions.
- Host: GitHub
- URL: https://github.com/yuri-val/auto-pr-description-action
- Owner: yuri-val
- Created: 2024-10-26T17:04:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-08T13:54:06.000Z (over 1 year ago)
- Last Synced: 2025-02-13T05:29:39.539Z (over 1 year ago)
- Topics: description, diff, git, github, pull-request, review
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/auto-generate-pr-description
- Size: 362 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🤖 Auto-generate PR Description Action: Supercharge Your Pull Requests!
This 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.
## 🚀 Features
- Automatically generates detailed PR descriptions
- Uses OpenAI's powerful language models
- Customizable OpenAI model and temperature settings
- Supports GitHub Actions workflow
- Fetches diff content and commit messages for context
## 📝 ToDo
- [ ] Handles rate limiting and retries API calls
- [ ] Configurable prompt templates for description generation
- [ ] Supports multiple languages for generated descriptions
## 📋 Requirements
- GitHub repository
- OpenAI API key
## 🛠️ Installation
1. Create a `.github/workflows/auto-pr-description.yml` file in your repository.
2. Add the following content to the file:
```yaml
name: Auto-generate PR Description
on:
pull_request:
types: [opened, synchronize]
jobs:
generate-description:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
issues: write
steps:
- uses: actions/checkout@v4
- name: Auto-generate PR Description
uses: yuri-val/auto-pr-description-action@v1
with:
openai_api_key: ${{ secrets.OPENAI_API_KEY }}
github_token: ${{ secrets.GITHUB_TOKEN }}
```
3. Add your OpenAI API key to your repository secrets as `OPENAI_API_KEY`.
## ⚙️ Configuration
You can customize the action by providing the following inputs:
| Input | Description | Required | Default |
|-------|-------------|----------|---------|
| `openai_api_key` | Your OpenAI API Key | Yes | N/A |
| `openai_model` | OpenAI model to use (e.g., gpt-5.4-mini, gpt-4o) | No | gpt-5.4-mini |
| `github_token` | GitHub token with repo permissions | Yes | ${{ github.token }} |
| `temperature` | Sampling temperature for OpenAI (0.0 to 1.0) | No | 0.7 |
## 📤 Outputs
The action provides the following outputs:
- `pr_number`: The number of the pull request updated
- `description`: The generated pull request description
## 🤝 Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/yuri-val/auto-pr-description-action/issues).
## 📝 License
This project is [MIT](https://opensource.org/licenses/MIT) licensed.
## 👤 Author
**Yuri V**
* GitHub: [@yuri-val](https://github.com/yuri-val)
## 🙏 Acknowledgements
- OpenAI for providing the powerful language models
- GitHub Actions for the seamless integration
---
If you find this action helpful, please consider giving it a ⭐️!