Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Slack notifications for issue/PR open/close actions #496

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 118 additions & 0 deletions .github/workflows/slack.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# Post a slack message something like the following for issue and PR actions:
# <$url|$title>
# | $repo#$num · issue opened by $user
#
# Configuration:
# 1. Set `SLACK_CHANNEL`.
# 2. Add a `SLACK_BOT_TOKEN` secret to your repo. This is the "Bot User OAuth
# Token" from the "OAuth & Permissions" section of your Slack App
# (https://api.slack.com/apps). The token must have the `chat:write`
# permission.
# 3. Optionally tweak the `if:` and `on:` sections below to control which issue
# and PR events are skipped.

name: slack

env:
SLACK_CHANNEL: "#apm-agent-node"

on:
issues:
types: [opened, reopened, closed]
pull_request:
types: [opened, ready_for_review, reopened, closed]

jobs:
slack:
# Skip notification if:
# - dependabot PRs, too noisy
# - draft PRs
if: ${{ github.event.pull_request.user.login != 'dependabot[bot]' || !(github.event.action == 'opened' && github.event.pull_request.draft) }}
runs-on: ubuntu-latest
steps:
- name: Prepare Slack message
id: prepare
shell: python
env:
GITHUB_CONTEXT: ${{ toJson(github) }}
run: |
import os
from pprint import pprint
import json
from html import escape

CLOSED_RED = '#cb2431'
GITHUB_BLACK = '#24292f'
MERGED_PURPLE = '#6f42c1'
OPEN_GREEN = '#36a64f'
DRAFT_GRAY = '#6a737d'

ctx = json.loads(os.environ["GITHUB_CONTEXT"])
pprint(ctx) # debug dump for now
event = ctx["event"]
action = event["action"]
if "issue" in event:
title = event["issue"]["title"]
url = event["issue"]["html_url"]
num = event["issue"]["number"]
action_str = f"issue {action}"
color = {
"opened": OPEN_GREEN,
"reopened": OPEN_GREEN,
"closed": CLOSED_RED,
}.get(action, "#ffffff")
elif "pull_request" in event:
title = event["pull_request"]["title"]
url = event["pull_request"]["html_url"]
num = event["pull_request"]["number"]
if action == "closed":
if event["pull_request"]["merged"]:
action_str = "PR merged"
color = MERGED_PURPLE
else:
action_str = "PR closed"
color = CLOSED_RED
elif event["pull_request"]["draft"]:
action_str = "PR in draft"
color = DRAFT_GRAY
elif action == "ready_for_review":
action_str = "PR ready for review"
color = OPEN_GREEN
elif:
action_str = "PR opened"
color = OPEN_GREEN
else:
pprint(ctx)
raise ValueError('unexpected event: not an issue or PR event')

# Use https://app.slack.com/block-kit-builder to play with styling.
payload = {
"channel": os.environ["SLACK_CHANNEL"],
"text": f"<{url}|{escape(title)}>", # escape angle-brackets
"attachments": [
{
"color": color,
"blocks": [
{
"type": "context",
"elements": [
{
"type": "mrkdwn",
"text": f"{ctx['repository']}#{num} · *{action_str}* by {event['sender']['login']}"
}
]
}
]
}
]
}

with open(os.environ.get("GITHUB_OUTPUT"), "a") as f:
f.write("payload={}".format(json.dumps(payload)))

- name: Post Slack message
uses: slackapi/slack-github-action@v2.0.0
with:
method: chat.postMessage
token: ${{ secrets.SLACK_BOT_TOKEN }}
payload: ${{ steps.prepare.outputs.payload }}
Loading