summaraizer GitHub Action

What?

Summaraizer summarizes your GitHub issues and pull requests discussions.

How?

This is an example workflow file how to use this action:

name: Summaraizer
'on':
  issue_comment:
    types:
    - created
jobs:
  summarize:
    runs-on: ubuntu-latest
    if: contains(github.event.comment.body, 'AI summarize please')
    permissions:
      issues: write
    steps:
    - name: Summarize
      uses: ioki-mobility/summaraizer-action@main
      with:
        provider: 'ollama'
        provider-args: '--url https://ollama.example.com --model llama3.1'
        gh-token: ${{ secrets.GITHUB_TOKEN }}

The workflow will run if you create a comment that contains: AI summarize please. It will then install the summaraizer CLI and invoke it with the given provider parameters and the automatically added github parameters from where this workflow was triggered by. Finally, it will create a comment on that issue with the summarization of it.

Checkout the summaraizer project for all possible providers and their respective arguments.

Please note that you could also run ollama within your GitHub Action.

The permission issue: write is required to add the comment to your issue.

Why?

Ever run into a situation to got a bit overhelmed with the amound of comments inside an issue or pull request? Or you just came back from a nice 3 weeks vacation trip and now has to read a 75 comments long issue to keep on track?

Such problems are from the past now! Just run the summaraizer over it to get a summarization of all comments to get on track faster than ever before!

Action Inputs

Full a full-reference, checkout the action.yml file.

gh-token
The GitHub token that read and write access to your repository. Defaults to ${{ github.token }}.

summaraizer-version
The version of the summaraizer cli that is used. Defaults to v0.0.1-alpha.00.

provider
The (ai) provider to use to summarize the comments. Defaults to ollama.

provider-args
The arguments for the choosen provider. Checkout the summaraizer documentation for more information.

Release

1. Checkout the repo (git clone ...)
2. Install npm
3. Run npm install
4. Run npm run build
5. Push to the repo