Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
message-square

GitHub Action

Mention to Slack Actions

4.1

Mention to Slack Actions

message-square

Mention to Slack Actions

Convert Github mention to Slack mention

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Mention to Slack Actions

              
  uses: Laurenfrost/mention-to-slack@4.1
Learn more about this action in Laurenfrost/mention-to-slack

Choose a version

Convert Github mention to Slack mention

!!! This action modified from actions-mention-to-slack !!!

This action sends mention to your slack account when you have been mentioned at github.

Feature

  • Send mention to slack if you had some modification on:
    • pull request
    • issue
  • Send notification to slack if you have been requested to review.
  • Send context to slack if you comment on a PR or Issue. Both PR comments and Issue comments are triggered by issue_comment event. And workflows should be at default branch to trigger issue_comment event.

TODO

  • Send mention to slack if you have been mentioned
    • Review
    • Review comments
    • more and more

Inputs

Name Required Default Description
configuration-path Yes .github/mention-to-slack.yml Mapping config for Github username to Slack member ID.
slack-webhook-url Yes Null Slack Incomming Webhook URL to notify.
repo-token Yes Null Github access token to fetch .github/mention-to-slack.yml file.
bot-name No Github Mention To Slack Display name for this bot on Slack.
icon-url No Null Display icon url for this bot on Slack.
run-id No Null Used for the link in the error message when an error occurs.
debug-flag No false Set true to show debug info in workflows log.

Example usage

.github/workflows/mention-to-slack.yml

name: mention-to-slack-actions

on:
  issues:
    types: [opened, edited]
  issue_comment:
    types: [created, edited]
  pull_request:
    types: [opened, reopened, edited, closed, review_requested]
  pull_request_review:
    types: [submitted]
  pull_request_review_comment:
    types: [created, edited]

jobs:
  mention-to-slack:
    runs-on: ubuntu-latest
    steps:
      - name: Mention to Slack Actions
        uses: Laurenfrost/mention-to-slack@latest
        with:
          configuration-path: .github/mention-to-slack.yml
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          slack-webhook-url: ${{ secrets.SLACK_WEBHOOK_URL }}
          icon-url: https://github.githubassets.com/images/modules/logos_page/Octocat.png
          bot-name: ${{github.repository}}
          run-id: ${{ github.run_id }}
          debug-flag: false

.github/mention-to-slack.yml

# For Github User
# github_username: "slack_member_id"

github_username_A: "slack_member_id_A"
github_username_B: "slack_member_id_B"
github_username_C: "slack_member_id_C"
abeyuya: "XXXXXXXXX"

# For Github Team
# github_teamname: "slack_member_id"

github_teamname_A: "slack_member_id_D"