Skip to content

Commit

Permalink
Merge branch 'release/v1.0.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
sunaoka committed Jun 25, 2024
2 parents d1d59a7 + ef682d5 commit 972c031
Show file tree
Hide file tree
Showing 2 changed files with 116 additions and 0 deletions.
49 changes: 49 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Test

on:
push:
workflow_dispatch:
schedule:
- cron: '45 1 * * *'

jobs:

test_v4:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ ubuntu-latest ]
php: [ '8.1', '8.2', '8.3' ]
laravel: [ 10, 11 ]
exclude:
- php: 8.1
laravel: 11

name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }}

steps:
- name: Setup PHP ${{ matrix.php }}
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
ini-values: error_reporting=E_ALL
tools: composer:v2

- name: Checkout
uses: actions/checkout@v4

- name: Install dependencies
run: |
composer require "illuminate/log=^${{ matrix.laravel }}" --no-update
composer update --prefer-dist --no-interaction --no-progress
- name: Run test suite
run: vendor/bin/phpunit --coverage-clover=coverage.xml

- name: Upload coverage reports to Codecov
uses: codecov/[email protected]
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: ./coverage.xml
fail_ci_if_error: false
67 changes: 67 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Laravel Slack Log Driver (Block Kit with Incoming webhooks)

Laravel Log Driver for sending Block Kit messages to incoming webhooks in Slack.

[![Latest](https://poser.pugx.org/sunaoka/laravel-slack-block-kit-web-hook-driver/v)](https://packagist.org/packages/sunaoka/laravel-slack-block-kit-web-hook-driver)
[![License](https://poser.pugx.org/sunaoka/laravel-slack-block-kit-web-hook-driver/license)](https://packagist.org/packages/sunaoka/laravel-slack-block-kit-web-hook-driver)
[![PHP](https://img.shields.io/packagist/php-v/sunaoka/laravel-slack-block-kit-web-hook-driver)](composer.json)
[![Laravel](https://img.shields.io/badge/laravel-10.x%20%7C%2011.x-red)](https://laravel.com/)
[![Test](https://github.com/sunaoka/laravel-slack-block-kit-web-hook-driver/actions/workflows/test.yml/badge.svg?branch=develop)](https://github.com/sunaoka/laravel-slack-block-kit-web-hook-driver/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/sunaoka/laravel-slack-block-kit-web-hook-driver/branch/develop/graph/badge.svg)](https://codecov.io/gh/sunaoka/laravel-slack-block-kit-web-hook-driver)

----

## Installation

```bash
composer require sunaoka/laravel-slack-block-kit-web-hook-driver
```

## Setup

`config/logging.php` configuration file:

```php
return [
'channels' => [
'slack' => [
'driver' => 'custom', // Set "custom" driver
'url' => env('LOG_SLACK_WEBHOOK_URL'),
'username' => env('LOG_SLACK_USERNAME', 'Laravel Log'),
'level' => env('LOG_LEVEL', 'info'),
'via' => \Sunaoka\Laravel\Log\Slack::class
],
],
];
```

## Usage

```php
<?php

$blocks = [
'username' => config('logging.channels.slack.username'),
'blocks' => [
[
'type' => 'section',
'text' => [
'type' => 'mrkdwn',
'text' => "You have a new request:\n*<fakeLink.toEmployeeProfile.com|Fred Enriquez - New device request>*",
],
],
[
'type' => 'section',
'fields' => [
['type' => 'mrkdwn', 'text' => "*Type:*\nComputer (laptop)"],
['type' => 'mrkdwn', 'text' => "*When:*\nSubmitted Aut 10"],
['type' => 'mrkdwn', 'text' => "*Last Update:*\nMar 10, 2015 (3 years, 5 months)"],
['type' => 'mrkdwn', 'text' => "*Reason:*\nAll vowel keys aren't working."],
['type' => 'mrkdwn', 'text' => "*Specs:*\n\"Cheetah Pro 15\" - Fast, really fast\""],
],
],
],
];

\Log::channel('info')->error(json_encode($blocks));
```

0 comments on commit 972c031

Please sign in to comment.