Skip to content
message-square

GitHub Action

Convert Pull Req Title Into Conventional Commit Scheme!

v1 Latest version

Convert Pull Req Title Into Conventional Commit Scheme!

message-square

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

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Convert Pull Req Title Into Conventional Commit Scheme!

              
  uses: ArnavK-09/convert_pull_req_title_into_conventional_commit_scheme@v1
Learn more about this action in ArnavK-09/convert_pull_req_title_into_conventional_commit_scheme

Choose a version

🌟🌟🌟

convert_pull_req_title_into_conventional_commit_scheme

Note

The 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.

This project is powered by the Google Gemini Pro API, which enables seamless integration and efficient conversion of pull request titles.

📐 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 for the action.
  • Click on the "Set up a workflow" button.
  • Choose the repository where you want to use the action.
  • Create a new workflow file (e.g., .github/workflows/convert-pull-request-title.yml).
  • Add the following code to the workflow file:
name: Convert Pull Req Title Into Conventional Commit Scheme

on:
pull_request:
    types:
    - opened

jobs:
  convert:
      runs-on: ubuntu-latest
      steps:
      - name: Checkout repository
          uses: actions/checkout@v2

      - name: Convert Pull Request Title into Conventional Commit Scheme
          uses: ArnavK-09/convert_pull_req_title_into_conventional_commit_scheme@v1
          with:
          gemini_api_key: ${{ secrets.GEMINI_API_KEY }}
          owner: ${{ github.repository_owner }}
          repo: ${{ github.repository }}
          pr_number: ${{ github.event.pull_request.number }}
          token: ${{ secrets.GITHUB_TOKEN }}
          include_emoji: true

2. 🔅 Action Inputs

Input Name Description
gemini_api_key The API key for accessing the Google Gemini LLM API.
owner The owner of the repository where the action is being used.
repo The name of the repository where the action is being used.
pr_number The pull request number for which the title needs to be converted.
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

To use this action, create a new pull request with a title that follows the conventional commits format. The action will automatically convert the pull request title into a conventional commit message and add it to the pull request.

🎋 Links