forked from Co-qn/google-chat-notification
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: ThinhHV <[email protected]>
- Loading branch information
1 parent
a6575a7
commit 4a83965
Showing
4 changed files
with
20 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,33 @@ | ||
# Google Chat Notification for GitHub Actions | ||
|
||
![](https://github.com/nakamuraos/google-chat-notifications/workflows/Build/badge.svg) | ||
|
||
Sends a Google Chat notification. | ||
|
||
This repository is generated by [typescript-action](https://github.com/actions/typescript-action). | ||
|
||
![Preview](images/preview.png "Preview") | ||
![Preview](images/preview.png 'Preview') | ||
|
||
## Usage | ||
|
||
### Parameters | ||
|Name|Required|Description| | ||
|:---:|:---:|:---| | ||
|title|true|Job title. Used for notification titles.| | ||
|subtitle|false|Job subtitle. Used for notification subtitles. We recommend using `${{ github.event.head_commit.message }}`| | ||
|webhookUrl|true|Google Chat Webhook URL.| | ||
|status|true|Job status. Available values are `success`, `failure`, `cancelled`. We recommend using `${{ job.status }}`| | ||
|threadKey|false|Thread key string. Used for send messages to a specific thread in a space| | ||
|
||
| Name | Required | Default | Description | | ||
| :--------: | :------: | :-----: | :---------------------------------------------------------------------------------------------------------- | | ||
| title | | "Build" | Job title. Used for notification titles. | | ||
| subtitle | | | Job subtitle. Used for notification subtitles. We recommend using `${{ github.event.head_commit.message }}` | | ||
| webhookUrl | ✅ | | Google Chat Webhook URL. | | ||
| status | ✅ | | Job status. Available values are `success`, `failure`, `cancelled`. We recommend using `${{ job.status }}` | | ||
| threadKey | | | Thread key string. Used for send messages to a specific thread in a space | | ||
|
||
### Examples | ||
|
||
```yaml | ||
- name: Google Chat Notification | ||
uses: nakamuraos/[email protected] | ||
with: | ||
title: Build | ||
subtitle: ${{ github.event.head_commit.message }} | ||
webhookUrl: ${{ secrets.GOOGLE_CHAT_WEBHOOK }} | ||
status: ${{ job.status }} | ||
threadKey: ${{ secrets.GOOGLE_CHAT_THREAD_KEY }} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters