https://github.com/xinthink/action-telegram

Telegram notification for workflow set up with GitHub Actions
https://github.com/xinthink/action-telegram

github-actions javascript-action notification telegram workflow

Last synced: 10 days ago
JSON representation

Telegram notification for workflow set up with GitHub Actions

• Host: GitHub
• URL: https://github.com/xinthink/action-telegram
• Owner: xinthink
• License: mit
• Created: 2019-08-29T07:08:41.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T21:58:56.000Z (almost 2 years ago)
• Last Synced: 2024-10-13T02:03:12.686Z (25 days ago)
• Topics: github-actions, javascript-action, notification, telegram, workflow
• Language: TypeScript
• Size: 3.43 MB
• Stars: 35
• Watchers: 6
• Forks: 22
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# action-telegram

[![Check Status][check-badge]][github-runs]

[![MIT][license-badge]][license]

A simple [Action] sending [Telegram] notifications for workflows set up with [GitHub Actions].

There's an [article on Medium](https://xinthink.com/build-your-own-github-actions-f3454f22f202) described in detail how I build this [Action].

[check-badge]: https://github.com/xinthink/action-telegram/workflows/Check/badge.svg

[github-runs]: https://github.com/xinthink/action-telegram/actions

[license-badge]: https://img.shields.io/github/license/xinthink/action-telegram

[license]: https://raw.githubusercontent.com/xinthink/action-telegram/master/LICENSE

## Usage

Add a step to your [workflow] in order to receive [Telegram] notifications, for example:

```yml

- name: notification

  if: cancelled() == false

  uses: xinthink/[email protected]

  with:

    botToken: ${{ secrets.BotToken }}

    chatId: ${{ secrets.ChatID }}

    jobStatus: ${{ job.status }}

```

> You can find more details in [action.yml]

The [Telegram] message will look like:

  - BOT name

    🔴 [owner/repo]() Check **Failure**

    `refs/heads/master` `5cabc6f` by **author**

    [View details]()

> Where `Check` will be the name of your workflow

## Development

[Yarn] is preferred for everyday tasks, so there's a `yarn.lock` instead of `package-lock.json` on the *master* branch. We will use [yarn run] ([npm scripts]) for handling the *node_modules* stuff, and also compiling [TypeScript] sources.

- Run command `yarn release` before committing to *release* branches

- Run command `yarn dev` before doing development tasks or committing to the *master* branch

[GitHub Actions]: https://help.github.com/en/articles/about-github-actions

[Action]: https://help.github.com/en/articles/about-actions

[workflow]: https://help.github.com/en/articles/workflow-syntax-for-github-actions

[Telegram]: https://telegram.org

[action.yml]: https://github.com/xinthink/action-telegram/blob/master/action.yml

[yarn]: https://yarnpkg.com/

[yarn run]: https://yarnpkg.com/lang/en/docs/cli/run/

[npm scripts]: https://docs.npmjs.com/misc/scripts

[TypeScript]: https://www.typescriptlang.org