https://github.com/jiangweixian/actions-article-helper

Check issue article grammar with ChatGPT
https://github.com/jiangweixian/actions-article-helper

actions blog chatgpt workflow

Last synced: about 2 months ago
JSON representation

Check issue article grammar with ChatGPT

• Host: GitHub
• URL: https://github.com/jiangweixian/actions-article-helper
• Owner: JiangWeixian
• License: mit
• Created: 2023-02-12T01:43:23.000Z (over 3 years ago)
• Default Branch: v1
• Last Pushed: 2023-11-05T01:22:29.000Z (over 2 years ago)
• Last Synced: 2025-02-04T18:41:56.603Z (over 1 year ago)
• Topics: actions, blog, chatgpt, workflow
• Language: TypeScript
• Homepage:
• Size: 14.3 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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](https://pbs.twimg.com/media/Foxfv3GagAAHChH?format=jpg&name=medium)

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

## features

- 🔍 Check issue article grammar

- 📝 Generate issue article description

*This actions will comment result under issue.*

## usage

```yaml

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](https://www.npmjs.com/package/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

- `GITHUB_TOKEN` - in repo `settings/actions` page, choose `Read and write permissions` or create `PAT` with `issues` scope

- `OPENAI_API_KEY` - create in https://platform.openai.com/account/api-keys