https://github.com/brianmitchl/pr-chatter-action

Add fun chatter to your Pull Requests
https://github.com/brianmitchl/pr-chatter-action

code-review gif github-actions pull-requests

Last synced: about 2 months ago
JSON representation

Add fun chatter to your Pull Requests

• Host: GitHub
• URL: https://github.com/brianmitchl/pr-chatter-action
• Owner: BrianMitchL
• License: mit
• Created: 2021-01-25T18:52:38.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-05-01T01:49:38.000Z (almost 2 years ago)
• Last Synced: 2024-11-29T08:40:16.755Z (2 months ago)
• Topics: code-review, gif, github-actions, pull-requests
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/pr-chatter
• Size: 325 KB
• Stars: 2
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pr-chatter-action

Intelligent GIF replies for Pull Request approvals and when changes are

requested.

The action looks at the review body text and analyzes the sentiment of the

text to influence the keyword used for finding a GIF.

This action is designed to be run on the `pull_request_review` event

```yaml

on:

  pull_request_review:

    types: [submitted]

```

## Inputs

### `TENOR_API_KEY`

**Required** Key for the Tenor GIFs API

### `GITHUB_TOKEN`

**Optional** GitHub Token for authentication

GitHub token used for posting comments on the PR. This defaults

to using the built-in GitHub token for the repository and comments

as the "github-actions" bot. You can set this as a personal access

token (PAT) if you want to comment as another account.

### `approved-gif-keywords`

**Optional** Comma separated string of keywords to randomly use for embedding

PR approved GIFs

This defaults to `'amazing, approve, awesome, great work, good job, hooray, incredible, joy, looks good, nice, perfect, thumbs up, wonderful'`

### `changes-requested-gif-keywords`

**Optional** Comma separated string of keywords to randomly use for embedding

PR changes requested GIFs

This defaults to `'try again, review, at least you tried, so close, dumpster fire, terrible, awful, disgusting, sad'`

## Usage

```yaml

# run the action on the `pull_request_review` event

on:

  pull_request_review:

    types: [submitted]

# later in the job steps

- uses: BrianMitchL/pr-chatter-action@v1

  with:

    # required

    TENOR_API_KEY: ${{ secrets.TENOR_API_KEY }}

    # optional

    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

    # optional

    approved-gif-keywords: 'amazing, approve, awesome, great work, good job, hooray, incredible, joy, looks good, nice, perfect, thumbs up, wonderful'

    # optional

    changes-requested-gif-keywords: 'try again, review, at least you tried, so close, dumpster fire, terrible, awful, disgusting, sad'

```