/bossbot-action

Github Action that looks for unwanted email content in issue comments and removes it.

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

BossBot - Github Issue Comment Cleanup - Github action

Github action that looks for unwanted email content in issue comments and removes it.

It currently handles standard email reply text format from Outlook and Gmail.

It works when comments are posted or edited on issues.

BossBot is named in reference Tony Danza's character in "Who's the Boss".

How to use

If you do not have any Github actions already set up in your repo, start by creating a .github/workflows folder.

Inside your workflows folder, create a new .yml file, for example main.yml and copy the following lines:

Don't forget that this must be merged into your primary branch (such as main or master) for Github to see it.

on: [issue_comment]

jobs:
  bossbot_issue_comment_cleanup:
    runs-on: ubuntu-latest
    name: BossBot Issues Cleanup
    steps:
      - uses: actions/checkout@v2
      - name: BossBot Issues Cleanup - action step
        uses: banagale/bossbot-action@master
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          SHOW_ANNOTATION: true
  • GITHUB_TOKEN is required (note that Github automatically creates this token) but two other parameters are optional:
  • show_annotation is optional and true if unset. Set to false if you do not want messages edited by BossBot to include an annotation

The action can take up to ~30 seconds to run after an issue comment is added or edited.

Acknowledgements

BossBot is based originally on safe-space by @charliegerard