/pr-status-giphy-action

A GitHub Action that displays a random thumbs up or thumbs down gif from giphy when pull request checks finish.

Primary LanguageJavaScriptMIT LicenseMIT

Pull Request Status Checks GIF

This is a fork from jzweifel's action, where I had to change the type of image to get, so it can show on GitHub PR comments. I have to express my deepest thanks to jzweifel by creating this awesome action!

A GitHub Action that displays a random thumbs up or thumbs down gif from Giphy when all checks on a Pull Request complete.

It will automatically clean up an existing comment before making a new one if checks are re-run. Works best when used in a workflow that runs on the pull_request event.

Usage

Simple run based on PR

on: pull_request
name: Pull Request Status Checks GIF
jobs:
  giphy:
    name: PR status gif
    runs-on: ubuntu-latest
    steps:
    - name: PR status gif
      uses: dgteixeira/pr-status-giphy-action@v2
      env:
        GIPHY_API_KEY: ${{ secrets.GIPHY_API_KEY }}
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

After a specific workflow

on:
  workflow_run:
    workflows: [workflow-name]
    types:
      - completed

name: Pull Request Status Checks GIF
jobs:
  giphy:
    name: PR status gif
    runs-on: ubuntu-latest
    steps:
    - name: PR status gif
      uses: dgteixeira/pr-status-giphy-action@v2
      env:
        GIPHY_API_KEY: ${{ secrets.GIPHY_API_KEY }}
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Secrets

  • GITHUB_TOKEN - Required.
  • GIPHY_API_KEY - Required. Your secret Giphy Api Key. You can create this key here.

How it looks

Status Checks OK

thumbs-up-pr

Status Checks NOT OK

thumbs-down-pr

License

The Dockerfile and associated scripts and documentation in this project are released under the MIT License.

Container images built with this project include third party materials. See THIRD_PARTY_NOTICE.md for details.