The Good Place - A GitHub Action 🍤

#actionshackathon #javascript #github #showdev

My Workflow

The Good Place may have ended, but you can be an architect of your own neighborhood (your repository) with The Good Place action! This GitHub Action:

Replaces curse words in Issues and Pull Requests with approved words in The Good Place

Comments a forking accurate GIF when you first label an issue (supports GitHub's default labels)

Submission Category

I absolutely LOVE this show! I can't get the idea out of my head so here it is. This is an entry for Wacky Wildcards. 🍤

Yaml File or Link to Code

More info about the action can be found here:

jayehernandez / the-good-place

A GitHub Action that lets you be an architect of your own neighborhood (your repository) in The Good Place

A GitHub Action that lets you be an architect of your own neighborhood (your repository) in The Good Place

🍤 Features

Replaces curse words in Issues and Pull Requests with approved words in The Good Place

Comments a forking accurate GIF when you first label an issue (supports GitHub's default labels)

🧐 How to Use

Create a new file titled action.yml inside the .github/workflows directory of your repository and copy the code below.

on
  issues
    types: [opened, edited, labeled]
  issue_comment
    types: [created, edited]
  pull_request:
    types: [opened, edited]
  pull_request_review_comment:
    types: [created, edited]
jobs:
  build:
    runs-on: ubuntu-latest
    name: The Good Place
    steps:
      - name: The Good Place Action
        uses: jayehernandez/the-good-place@v1.1
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}

🙏🏻 Acknowledgements

Octokit Rest API
GIFs from Giphy

Give a ⭐️ if you think this project is cool!

…

View on GitHub

Or, you can create a new file titled action.yml inside the .github/workflows directory of your repository and copy the code below.

on:
  issues:
    types: [opened, edited, labeled]
  issue_comment:
    types: [created, edited]
  pull_request:
    types: [opened, edited]
  pull_request_review_comment:
    types: [created, edited]
jobs:
  build:
    runs-on: ubuntu-latest
    name: The Good Place
    steps:
      - name: The Good Place Action
        uses: jayehernandez/the-good-place@v1.1
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}

v1.1 introduces a fix for the Scunthorpe problem as flagged in this comment!

Additional Resources / Info

The action was created using JavaScript and the Octokit API. The documentation provided for Octokit was easy to understand for beginners like me. GIFs used were from GIPHY.

Huge thank you as well to the JavaScript Actions course of the GitHub Training Team which taught me the basic concepts I needed to learn. I highly suggest that you check that out if you'd like to create your own.

Are you a fan of The Good Place? Let me know what you think about this action!