README.md

IkarisGPT - Auto-Describe issues with ChatGPT 🤖

Just write issue titles and let IkarisGPT do the rest.
IkarisGPT is a OpenAI API based Github Action that provides bootstrap issue templates with issue-specific details in a markdown format, saving time that goes in formatting and writing general information.

Usage

Auto describe labelled issues

name: IkarisGPT Auto-Describe-Issue

on:
  issues:
    types:
      - labeled

jobs:
  AutoDescribe:
    if: github.event.label.name == 'auto-described'
    runs-on: ubuntu-latest
    name: IkarisGPT Auto Describe Issue
    steps:
      - name: IkarisGPT Action Step
        id: ikaris
        uses: devAyushDubey/Ikaris-GPT@v1.0.0-beta
        with:
          openai-api-key: ${{ secrets.OPENAI_API_KEY }}
      - name: Get the output message
        run: echo "${{ steps.ikaris.outputs.message }}"

Use Custom ChatGPT prompts

name: IkarisGPT Auto-Describe-Issue

on:
  issues:
    types:
      - labeled

jobs:
  AutoDescribe:
    if: github.event.label.name == 'auto-described'
    runs-on: ubuntu-latest
    name: IkarisGPT Auto Describe Issue
    steps:
      - name: IkarisGPT Action Step
        id: ikaris
        uses: devAyushDubey/Ikaris-GPT@v1.0.0-beta
        with:
          openai-api-key: ${{ secrets.OPENAI_API_KEY }}
          prompt: "Generate an issue description for an issue titled ${{ github.event.issue.title }}"
      - name: Get the output message
        run: echo "${{ steps.ikaris.outputs.message }}"

Action Inputs

Name	Description	Default
token	GITHUB_TOKEN (issues: write) or a repo scoped PAT.
openai-api-key	OpenAI API Key for using ChatGPT, use Github Secrets and add the API Key in secrets like OPENAI_API_KEY which can be used in the workflow as token: ${{ secrets.OPENAI_API_KEY }}. While testing I used GPT-3.5-Turbo.
prompt	A ChatGPT prompt for generating a markdown issue description based on the specifics of the issue title and project. ChatGPT Prompts

Important

• The action won't work without a valid OpenAI Api Key that has $ credits (not expired, check here).
• Make sure workflows have write permissions. This can be enabled through repository settings > actions > workflow permissions.

Eagerly looking for contributors 👋

License

GNU