{"id":16198131,"url":"https://github.com/xinthink/action-telegram","last_synced_at":"2025-03-16T10:32:44.496Z","repository":{"id":44840231,"uuid":"205102707","full_name":"xinthink/action-telegram","owner":"xinthink","description":"Telegram notification for workflow set up with GitHub Actions","archived":false,"fork":false,"pushed_at":"2023-01-04T21:58:56.000Z","size":3599,"stargazers_count":35,"open_issues_count":14,"forks_count":23,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-02-27T07:50:28.665Z","etag":null,"topics":["github-actions","javascript-action","notification","telegram","workflow"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xinthink.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":"paypal.me/xinthink/5"}},"created_at":"2019-08-29T07:08:41.000Z","updated_at":"2023-10-15T10:01:12.000Z","dependencies_parsed_at":"2023-01-11T17:22:41.023Z","dependency_job_id":null,"html_url":"https://github.com/xinthink/action-telegram","commit_stats":{"total_commits":30,"total_committers":1,"mean_commits":30.0,"dds":0.0,"last_synced_commit":"27b9554d0c9723ef4bed9fef6bc631b3e3197db4"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xinthink%2Faction-telegram","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xinthink%2Faction-telegram/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xinthink%2Faction-telegram/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xinthink%2Faction-telegram/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xinthink","download_url":"https://codeload.github.com/xinthink/action-telegram/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243814907,"owners_count":20352037,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","javascript-action","notification","telegram","workflow"],"created_at":"2024-10-10T09:11:35.246Z","updated_at":"2025-03-16T10:32:44.136Z","avatar_url":"https://github.com/xinthink.png","language":"TypeScript","funding_links":["paypal.me/xinthink/5"],"categories":[],"sub_categories":[],"readme":"# action-telegram\n\n[![Check Status][check-badge]][github-runs]\n[![MIT][license-badge]][license]\n\nA simple [Action] sending [Telegram] notifications for workflows set up with [GitHub Actions].\n\nThere's an [article on Medium](https://xinthink.com/build-your-own-github-actions-f3454f22f202) described in detail how I build this [Action].\n\n[check-badge]: https://github.com/xinthink/action-telegram/workflows/Check/badge.svg\n[github-runs]: https://github.com/xinthink/action-telegram/actions\n[license-badge]: https://img.shields.io/github/license/xinthink/action-telegram\n[license]: https://raw.githubusercontent.com/xinthink/action-telegram/master/LICENSE\n\n## Usage\n\nAdd a step to your [workflow] in order to receive [Telegram] notifications, for example:\n\n```yml\n- name: notification\n  if: cancelled() == false\n  uses: xinthink/action-telegram@v1.1\n  with:\n    botToken: ${{ secrets.BotToken }}\n    chatId: ${{ secrets.ChatID }}\n    jobStatus: ${{ job.status }}\n```\n\n\u003e You can find more details in [action.yml]\n\nThe [Telegram] message will look like:\n  - BOT name\n\n    🔴 [owner/repo]() Check **Failure**\n\n    `refs/heads/master` `5cabc6f` by **author**\n\n    [View details]()\n\n\u003e Where `Check` will be the name of your workflow\n\n## Development\n\n[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.\n\n- Run command `yarn release` before committing to *release* branches\n- Run command `yarn dev` before doing development tasks or committing to the *master* branch\n\n\n[GitHub Actions]: https://help.github.com/en/articles/about-github-actions\n[Action]: https://help.github.com/en/articles/about-actions\n[workflow]: https://help.github.com/en/articles/workflow-syntax-for-github-actions\n[Telegram]: https://telegram.org\n[action.yml]: https://github.com/xinthink/action-telegram/blob/master/action.yml\n[yarn]: https://yarnpkg.com/\n[yarn run]: https://yarnpkg.com/lang/en/docs/cli/run/\n[npm scripts]: https://docs.npmjs.com/misc/scripts\n[TypeScript]: https://www.typescriptlang.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxinthink%2Faction-telegram","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxinthink%2Faction-telegram","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxinthink%2Faction-telegram/lists"}