Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arnavk-09/convert_pull_req_title_into_conventional_commit_scheme
🥓 By utilizing this action, users can automatically convert new pull request titles into the conventional commits format
https://github.com/arnavk-09/convert_pull_req_title_into_conventional_commit_scheme
action gemini-api gh github-actions javascript marketplace
Last synced: 19 days ago
JSON representation
🥓 By utilizing this action, users can automatically convert new pull request titles into the conventional commits format
- Host: GitHub
- URL: https://github.com/arnavk-09/convert_pull_req_title_into_conventional_commit_scheme
- Owner: ArnavK-09
- License: mit
- Created: 2024-02-04T17:17:14.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-06T18:44:04.000Z (11 months ago)
- Last Synced: 2024-02-07T16:20:21.576Z (11 months ago)
- Topics: action, gemini-api, gh, github-actions, javascript, marketplace
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/convert-pull-req-title-into-conventional-commit-scheme
- Size: 350 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ✨ Convert Pull Req Title Into Conventional Commit Scheme!
> [!NOTE]
> The [**`convert_pull_req_title_into_conventional_commit_scheme`**](https://github.com/ArnavK-09/convert_pull_req_title_into_conventional_commit_scheme) project is a public **GitHub Action** available in the GitHub Marketplace. By utilizing this action, users can automatically **convert new pull request titles into the conventional commits format** as defined by [conventionalcommits.org](https://www.conventionalcommits.org/).
>
> This project is powered by the **Google Gemini Pro API**, which enables seamless integration and efficient conversion of pull request titles into conventional format messages.
---
## 📐 Setup Guide
> **To set up the `convert_pull_req_title_into_conventional_commit_scheme` action, follow these steps:**
### 1. 🔆**Action Setup**
- Visit the [GitHub Marketplace page](https://github.com/marketplace/actions/convert-pull-req-title-into-conventional-commit-scheme) for the action.
- Click on the "Set up a workflow" button.
- Choose the repository where you want to use the action.
- Add ` GEMINI_API_KEY ` secret in your repository secrets from settings
- Create a new workflow file (e.g., `.github/workflows/convert-pull-request-title.yml`).
- **Add the following code to the workflow file:**
```yaml
name: Convert Pull Req Title Into Conventional Commit Scheme!
on:
pull_request:
types: ['opened']
jobs:
convert:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Convert Pull Request Title into Conventional Commit Scheme
uses: ArnavK-09/convert_pull_req_title_into_conventional_commit_scheme@main
with:
gemini_api_key: ${{ secrets.GEMINI_API_KEY }}
token: ${{ secrets.GITHUB_TOKEN }}
```
### 2. 🔅 **Action Inputs**
| Input Name | Description |
| ---------------- | --------------------------------------------------------------------------------------------------------------- |
| `gemini_api_key` | The API key for accessing the Google Gemini LLM API. |
| `token` | The GitHub token for authentication and authorization. Use `${{ secrets.GITHUB_TOKEN }}` to access it securely. |
| `include_emoji` | Set this to `true` if you want to include emojis in starting of converted commit prTitle title. |
> [!TIP]
>
> ##### 🥓 Example Usage **[#12](https://github.com/ArnavK-09/convert_pull_req_title_into_conventional_commit_scheme/pull/12)**
> To use this action, create a new pull request with a fuzzy title and good description.
> The action will automatically convert the pull request title into a conventional commit message and patch it to the pull request.
---
## 🎋 Links
- [GitHub Action: convert_pull_req_title_into_conventional_commit_scheme](https://github.com/marketplace/actions/convert-pull-req-title-into-conventional-commit-scheme)
- [Repository: ArnavK-09/convert_pull_req_title_into_conventional_commit_scheme](https://github.com/ArnavK-09/convert_pull_req_title_into_conventional_commit_scheme)
- [Title Format: Conventional Commit Rules](https://www.conventionalcommits.org/)
🌟 Star this repo :)