https://github.com/jayehernandez/the-good-place

A GitHub Action that lets you be an architect of your own neighborhood (your repository) in The Good Place
https://github.com/jayehernandez/the-good-place

github-actions javascript octokit-js

Last synced: about 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jayehernandez/the-good-place
• Owner: jayehernandez
• License: mit
• Created: 2020-08-18T14:47:04.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2025-04-11T09:44:36.000Z (about 1 year ago)
• Last Synced: 2025-04-11T11:49:47.751Z (about 1 year ago)
• Topics: github-actions, javascript, octokit-js
• Language: JavaScript
• Homepage:
• Size: 1.76 MB
• Stars: 53
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Hero Image](images/hero.png)



  

    

  

  

    

  

  

    

  



> 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

![Feature 1 Demo](images/feature1.png)

- Comments a forking accurate GIF when you first label an issue (supports GitHub's [default labels](https://docs.github.com/en/github/managing-your-work-on-github/about-labels#using-default-labels))

![Feature 2 Demo](images/feature2.png)

## 🧐 How to Use

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

```yaml

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](https://developer.github.com/v3/libraries/)

* GIFs from [Giphy](giphy.com)

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

This is an entry to dev.to's [GitHub Actions Hackathon](https://dev.to/devteam/announcing-the-github-actions-hackathon-on-dev-3ljn). I wrote about it [here](https://dev.to/jayehernandez/the-good-place-a-github-action-365m).

## 📝 License

Copyright © 2020 [Jaye Hernandez](https://jayehernandez.com).


This project is [MIT](https://github.com/jayehernandez/the-good-place/blob/master/LICENSE) licensed.