GitHub workflow to greet new issues and pull requests with random jokes

See it on Marketplace »
View Demo · Report Bug · Request Feature

Subscribe to receive updates

Table of Contents

• About the Project
  • Built With
• Getting Started
• Usage
• Roadmap
• Version History
• Contributing
• Support
• License
• Contact
• Related Works

About The Project

This workflow comments on a new issue or pull request by a lovely greeting and with a complimentary joke. For now it supports programming jokes only, will add more jokes soon.

On new Issues

On new Pull Requests

Built With

• @actions/toolkit
• JokeAPI

Getting Started

Any public or private repository can run this workflow by copying greet_with_joke.yml file to their .github/workflows directory.

Usage

Default configuration

name: "Greet With A Random Joke"
on:
  issues:
    types: [opened, reopened]
  pull_request_target:
    types: [opened, reopened]

jobs:
  test:
    name: setup environment
    runs-on: ubuntu-latest
    steps:
      - name: mast joke mara
        uses: deep5050/MastJokeMara@main
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Custom configuration [NEW]

name: "Greet With A Random Joke"
on:
  issues:
    types: [opened, reopened]
  pull_request_target:
    types: [opened, reopened]

jobs:
  test:
    name: setup environment
    runs-on: ubuntu-latest
    steps:
      - name: mast joke mara
        uses: deep5050/MastJokeMara@main
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          issue_msg: |
            Hi, {{author}} here is a joke for you 
            {{joke}}
          

          

When using Custom configuration DO NOT forget to include {{author}} and {{joke}}

Roadmap

See the open issues for a list of proposed features (and known issues).

Version History

v1.4.0 [Fork-PR support] Added support for fork-based PRs.

v1.3.0 [Custom message support] Added support for custom Issue and PR messages

v1.2.0 [Avoid issues raised by bot or owner] : Avoids issues/PRs raised by a bot or the owner himself. Also run only on issue or Pull Request opened and reopened events.

v1.1.0 [Avoid bots] : Avoids replying to the bot comments

v1.0.0 [Initial release] : Supports programming jokes

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch
3. Commit your Changes
4. Push to the Branch
5. Test by raising an issue or a PR on your own branch
6. Open a Pull Request

DO NOT make any changes to dist/index.js as it is automgically generated from index.js by vercel-ncc module.

Any changes made on index.js MUST be reflected on dist/index.js too as the workflow runs the dist/index.js NOT index.js on root.

Run npm run prepare before you push any changes made on index.js

Support

All Kinds Of Supports Are Welcome 🙌! The Most Basic Way To Show Your Support Is To Star 🌟 The Project, Or To Raise Issues 💬 You Can Also Support This Project By becoming a sponsor on GitHub 👏 Or By Making A Paypal Donation :)

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Dipankar Pal - dipankarpal5050@gmail.com

Related Works

NaughtyLust : Awesome Nautilus Scripts For Linux.

qikQR : Minimal QR Code Generator App Made With Electron.

cppcheck-action : Check Security Flaws In Your C/C++ Codes Right From GitHub Action Workflows.

autopy-lot : GitHub Action Setup To Convert Jupyter Notebooks To Python Scripts And Markdowns.

Happy Coding

participate on the poll for new features

Want more jokes on categories like Programming Miscellaneous Dark Pun

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Krazy 4 Code 🐛

Mayank Mohak 🚇 🐛 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!