Add Discord webhook at end of each CI run. (#20355)

This commit is contained in:
Nick Brassel 2023-04-07 16:37:06 +10:00 committed by GitHub
parent 4ba3fdfad2
commit 2e766a9c7a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 61 additions and 3 deletions

View File

@ -10,12 +10,11 @@ on:
jobs: jobs:
ci_builds: ci_builds:
if: github.repository == 'qmk/qmk_firmware'
name: "CI Build" name: "CI Build"
runs-on: self-hosted runs-on: self-hosted
timeout-minutes: 1380 timeout-minutes: 1380
if: github.repository == 'qmk/qmk_firmware'
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
@ -58,3 +57,12 @@ jobs:
*.hex *.hex
*.uf2 *.uf2
.build/failed.* .build/failed.*
- name: 'CI Discord Notification'
if: always()
working-directory: util/ci/
env:
DISCORD_WEBHOOK: ${{ secrets.CI_DISCORD_WEBHOOK }}
run: |
python3 -m pip install -r requirements.txt
python3 ./discord-results.py --branch ${{ matrix.branch }} --keymap ${{ matrix.keymap }} --url ${{ env.GITHUB_SERVER_URL }}/${{ env.GITHUB_REPOSITORY }}/actions/runs/${{ env.GITHUB_RUN_ID }}

View File

@ -7,7 +7,7 @@ from milc import cli
from qmk.path import normpath from qmk.path import normpath
py_file_suffixes = ('py',) py_file_suffixes = ('py',)
py_dirs = ['lib/python'] py_dirs = ['lib/python', 'util/ci']
def yapf_run(files): def yapf_run(files):

49
util/ci/discord-results.py Executable file
View File

@ -0,0 +1,49 @@
#!/usr/bin/env python3
import argparse
import os
import re
import sys
from pathlib import Path
from discord_webhook import DiscordWebhook, DiscordEmbed
parser = argparse.ArgumentParser(prog='discord-results.py', description='Sends a Discord webhook notification at the end of a CI run.')
parser.add_argument('-b', '--branch')
parser.add_argument('-k', '--keymap')
parser.add_argument('-u', '--url')
args = parser.parse_args()
qmk_dir = Path(__file__).resolve().parents[2].resolve()
keyboard_re = re.compile(r'CI Metadata: KEYBOARD=(.*)$', re.MULTILINE)
keymap_re = re.compile(r'CI Metadata: KEYMAP=(.*)$', re.MULTILINE)
successful_builds = sum([len(list(qmk_dir.glob(f'*.{extension}'))) for extension in ['uf2', 'bin', 'hex']])
failures = list(sorted([f.resolve() for f in (qmk_dir / '.build/').glob('failed.log.*')]))
failed_builds = []
for f in failures:
with open(f) as fh:
data = fh.read()
kb = keyboard_re.search(data).group(1)
km = keymap_re.search(data).group(1)
failed_builds.append(f'{kb}:{km}')
webhook = DiscordWebhook(url=os.getenv('DISCORD_WEBHOOK'), username="QMK GitHub CI")
if len(failed_builds) > 0:
failstr = ''
for f in failed_builds:
if len(failstr) >= 1800:
failstr += '<<snip>>'
break
failstr += f'{f}\n'
embed = DiscordEmbed(title=f':infinity: CI Build Failure ({args.branch}, {args.keymap})', description=f'**{successful_builds}** builds succeeded, **{len(failed_builds)}** builds failed:```{failstr}```', color='ff9999')
else:
embed = DiscordEmbed(title=f':infinity: CI Build Success ({args.branch}, {args.keymap})', description=f'**{successful_builds}** builds succeeded.', color='99ff99')
embed.add_embed_field(name='Build Target', value=f'[**{args.branch}**](https://github.com/qmk/qmk_firmware/tree/{args.branch}) / **{args.keymap}** keymap')
embed.add_embed_field(name='Workflow Run', value=f'[**Link**]({args.url})')
embed.set_timestamp()
webhook.add_embed(embed)
webhook.execute()

1
util/ci/requirements.txt Normal file
View File

@ -0,0 +1 @@
discord-webhook