https://github.com/codex-team/action-codexbot-notify

This action sends a notification message to Telegram or Slack chat
https://github.com/codex-team/action-codexbot-notify

action bot codex github-actions notification-message slack telegram

Last synced: 3 months ago
JSON representation

This action sends a notification message to Telegram or Slack chat

• Host: GitHub
• URL: https://github.com/codex-team/action-codexbot-notify
• Owner: codex-team
• License: mit
• Created: 2020-11-11T15:06:19.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-16T17:45:22.000Z (about 4 years ago)
• Last Synced: 2024-11-04T15:50:58.569Z (3 months ago)
• Topics: action, bot, codex, github-actions, notification-message, slack, telegram
• Language: JavaScript
• Homepage:
• Size: 56.6 KB
• Stars: 7
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![banner](./assets/banner.png)

# @codex_bot notifier

This action sends a notification message to Telegram or Slack chat.

Powered by [@codex_bot/notify](https://github.com/codex-bot/notify) application.

## Inputs

### `webhook`

**Required.** Endpoint for sending message to chat.

Read [the manual](https://github.com/codex-bot/notify#getting-started) to get a webhook endpoint for your chat. 

### `message`

**Required.** Message text.

### `parse_mode`

Mode for parsing entities in the message text. Empty by default.  

`HTML` or `Markdown` (case insensitive) styles are supported.

### `disable_web_page_preview`

Disables link previews for links in this message. `false` by default.

## Outputs

### `response-body`

Response message

### `response-code`

Response status code

## Usage

```

- name: Send a chat notification via @codex_bot

  uses: codex-team/action-codexbot-notify@v1

  with:

    webhook: ${{ secrets.CODEXBOT_NOTIFY_WEBHOOK }}

    message: '📦 [@editorjs/editorjs](https://npmjs.com/package/@editorjs/editorjs) 2.19.0 was published'

    parse_mode: 'markdown'

    disable_web_page_preview: true

```

You can use [codex-team/action-nodejs-package-info](https://github.com/codex-team/action-nodejs-package-info) to get package information automatically.

```

- name: Get package info

  id: package

  uses: codex-team/action-nodejs-package-info@v1

- name: Send a message

  uses: codex-team/action-codexbot-notify@v1

  with:

    webhook: ${{ secrets.CODEX_BOT_CHAT }}

    message: '📦 [${{ steps.package.outputs.name }}](${{ steps.package.outputs.npmjs-link }}) ${{ steps.package.outputs.version }}  was published'

    parse_mode: 'markdown'

    disable_web_page_preview: true

```