A GitHub Action that automatically generates and updates pull request descriptions with commit logs and version tracking. This action helps maintain consistent and informative PR documentation by automatically generating change logs from commit messages.
- 🔄 Automatically generates PR descriptions from commit logs
- 📝 Updates PR descriptions when new commits are pushed
- 🏷️ Tracks version numbers across releases
- 🚀 Automatically updates PR titles for merged PRs with version numbers
- 💬 Maintains change logs in PR comments
To use this action in your repository, create a workflow file (e.g., .github/workflows/pr-description.yml) with the following configuration:
| Input | Description | Required | Default |
|---|---|---|---|
github_token |
GitHub token for API access | Yes | ${{ github.token }} |
base_branch |
Base branch to track PRs against | No | dev |
team_branch |
Team branch name to filter PRs | No | Team |
The action generates PR descriptions in the following format:
The action automatically manages version numbers following these rules:
- Retrieves the latest version from GitHub releases
- Increments the patch version for each new release
- Updates PR titles with the new version number when merged
This action requires the following permissions:
contents: read- For accessing repository contentpull-requests: write- For updating PR descriptions and comments
Contributions are welcome! Please feel free to submit a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.
Created by @yashpapa6969