telewire's Introduction

Telewire 🛩 🌉

Rather than putting the tag, use the latest commit id to improve security

Telewire connects your GitHub Repo to Telegram about Repo Updates by a Bot you can create. The execution time for the action is nearly 10s

Create a chatbot with botfather bot in telegram. Get your chat id by speaking to jsondumpbot in telegram.

Since it is your repo and it should only be limited to you. Thats why you need to give your chat id to the bot. You can either give your personal chat id or a channel chat id and add the bot to it.

You can add these details to the Repository Secrets by going to <repo>/settings/secrets/

Notifications

You can use the simple notifier at the master branch or the release tag like

    - name: <WorkFlow Name>
      uses: athul/telewire@master
      if: always()
      with:
        chat: ${{ secrets.chat }}
        token: ${{ secrets.token }}
        status: ${{ job.status }}

The chat is the chat id/channel id and you can get that by talking to the json dump bot. The token is the bot's API token and you can create a bot by speaking to Botfather bot in Telegram.

Hacked from the Core of Statusoli for githubHackathon

Actions will only trigger on what you want to trigger. You might want to define all the triggers first. You can refer the workflow file of this repo for better guidance. or like this

name: Build and Notify
on:
  push:
  pull_request:
    types: [opened,closed]
  issues:
    types: [opened, closed, reopened]
  issue_comment:
    types: [created]
  watch:
    types: [started]

telewire's People