JiangWeixian / actions-article-helper

Check issue article grammar with ChatGPT
MIT License
0 stars 0 forks source link
actions blog chatgpt workflow

actions-article-helper

If you write article in github issue like me, you can use this action to check issue article grammar & generate article description.

screenshot

Check https://github.com/JiangWeixian/actions-article-helper/issues/1 for more details.

features

This actions will comment result under issue.

usage

name: article helper
on:
  issues:
    types:
      - opened
      - edited

jobs:
  debug:
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@v2
      - name: setup node.js
        uses: actions/setup-node@v2
        with:
          node-version: 16
      - name: article helper
        uses: jiangweixian/actions-article-helper@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

params

name description default
delimiters If issue body contain markdown metadata, it use gray-matter to strip it. e.g. "[\"<!--\", \"-->\"]"
ownerOnly Only owners allowed to trigger actions true
removeCodeblocks Remove code blocks in issue body(If you find the content of the comment incomplete, try to set this option to true) false

permissions