Motivate Me - GitHub Action

A GitHub action (written in JavaScript) that posts inspirational gifs on stale pull requests leveraging the GIPHY API. Powered by GIPHY and GitHub Actions!

Note: This project is in maintenance mode and is not currently actively being contributed to

Usage

Pre-requisites

Create a workflow .yml file in your .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.

Inputs

For more information on these inputs, see the GIPHY API Documentation.

query: The search query word or phrase to use when returning a GIF. Default: motivation
rating: The content rating used to filter results from the GIF search. Default: g
lang: The default language that the search query is in. Default: en for English
stale_days: Number of days of inactivity before a pull request receives motivation. Default: 14

Example workflow - motivate me

Every day, query open pull requests that are stale and add an inspirational comment powered by GIPHY to add a GIF:

on:
  schedule:
  - cron: 0 0 * * *  # Midnight every day – https://crontab.guru

name: Motivate Me

jobs:
  motivation:
    name: Motivate Me
    runs-on: ubuntu-latest
    steps:
      - name: Motivate Me
        id: motivate_me
        uses: iamhughes/motivate-me@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
          GIPHY_TOKEN: ${{ secrets.GIPHY_TOKEN }} # This token should be created on giphy.com: https://developers.giphy.com/dashboard/?create=true
        with:
          query: 'motivation'
          rating: 'g'
          lang: 'en'
          stale_days: 14

Contributing

I would love for you to contribute, pull requests are welcome! Please see the CONTRIBUTING.md for more information.

License

The scripts and documentation in this project are released under the GNU License

Disclaimer

This leverages the GIPHY API to query results based on inputs you provide and the rating you use. As a consumer of this action, you accept responsibility of any gifs that are posted by this bot. The owner of this action does not control the search algorithm or endpoint that is returning images and is not responsible for it's content.

IAmHughes / motivate-me