{"id":13901369,"url":"https://github.com/RocketChat/Rocket.Chat.GitHub.Action.Notification","last_synced_at":"2025-07-17T22:30:29.839Z","repository":{"id":48575363,"uuid":"223640505","full_name":"RocketChat/Rocket.Chat.GitHub.Action.Notification","owner":"RocketChat","description":"Rocket.Chat Notification for GitHub Actions :bell: :rocket: ","archived":false,"fork":false,"pushed_at":"2024-03-27T21:14:34.000Z","size":277,"stargazers_count":18,"open_issues_count":5,"forks_count":8,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-11-22T03:51:58.446Z","etag":null,"topics":[],"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/RocketChat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-23T19:16:16.000Z","updated_at":"2024-03-13T16:37:17.000Z","dependencies_parsed_at":"2024-06-18T21:36:57.055Z","dependency_job_id":"983a267e-e2c8-4777-957e-6cdfa9f122ef","html_url":"https://github.com/RocketChat/Rocket.Chat.GitHub.Action.Notification","commit_stats":{"total_commits":6,"total_committers":1,"mean_commits":6.0,"dds":0.0,"last_synced_commit":"2966f5f2e0313a94f965a51c08700cfecf0b6572"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2FRocket.Chat.GitHub.Action.Notification","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2FRocket.Chat.GitHub.Action.Notification/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2FRocket.Chat.GitHub.Action.Notification/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2FRocket.Chat.GitHub.Action.Notification/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RocketChat","download_url":"https://codeload.github.com/RocketChat/Rocket.Chat.GitHub.Action.Notification/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226305357,"owners_count":17603797,"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":[],"created_at":"2024-08-06T21:01:17.517Z","updated_at":"2024-11-25T09:31:19.920Z","avatar_url":"https://github.com/RocketChat.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Rocket.Chat.GitHub.Action.Notification\n\n![](https://github.com/RocketChat/Rocket.Chat.GitHub.Action.Notification/workflows/TS%20Lint%20Check/badge.svg)\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/RocketChat/Rocket.Chat.GitHub.Action.Notification?color=brightgreen)\n![GitHub](https://img.shields.io/github/license/RocketChat/Rocket.Chat.GitHub.Action.Notification?color=brightgreen)\n\nThis is Rocket.Chat Notification for GitHub Actions.\u003cbr\u003e\nForked from [homoluctus/slatify](https://github.com/homoluctus/slatify). Thanks a lot for your awesome work!\n\n# Feature\n- Notify the result of GitHub Actions\n- Support three job status (reference: [job-context](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions#job-context))\n  - success\n  - failure\n  - cancelled\n- Mention\n  - Notify message to channel members efficiently\n  - You can specify the condition to mention\n\n# How to use\nFirst of all, you need to set GitHub secrets for ROCKETCHAT_WEBHOOK that is Incoming Webhook URL.\u003cbr\u003e\nYou can customize the following parameters:\n\n|with parameter|required/optional|default|description|\n|:--:|:--:|:--|:--|\n|type|required|N/A|The result of GitHub Actions job\u003cbr\u003eThis parameter value must contain the following word:\u003cbr\u003e- `success`\u003cbr\u003e- `failure`\u003cbr\u003e- `cancelled`\u003cbr\u003eWe recommend using ${{ job.status }}|\n|job_name|required|N/A|Means rocket.chat notification title|\n|url|required|N/A|Rocket.Chat Incoming Webhooks URL\u003cbr\u003ePlease specify this key or ROCKETCHAT_WEBHOOK environment variable\u003cbr\u003e※ROCKETCHAT_WEBHOOK will be deprecated|\n|mention|optional|N/A|Rocket.Chat message mention|\n|mention_if|optional|N/A|The condition to mention\u003cbr\u003eThis parameter can contain the following word:\u003cbr\u003e- `success`\u003cbr\u003e- `failure`\u003cbr\u003e- `cancelled`\u003cbr\u003e- `always`|\n|icon_emoji|optional|Use Rocket.Chat Incoming Webhook configuration|Rocket.Chat icon|\n|username|optional|Use Rocket.Chat Incoming Webhook configuration|Rocket.Chat username|\n|channel|optional|Use Rocket.Chat Incoming Webhook configuration|Rocket.Chat channel name|\n|commit|optional|false|If true, Rocket.Chat notification includes the latest commit message and author.|\n|token|case by case|N/A|This token is used to get commit data.\u003cbr\u003eIf commit parameter is true, this parameter is required.\u003cbr\u003e${{ secrets.GITHUB_TOKEN }} is recommended.|\n\nPlease refer `action.yml` for more details.\n\n## Examples\n\n```..github/workflows/example1.yml\n- name: Rocket.Chat Notification\n  uses: RocketChat/Rocket.Chat.GitHub.Action.Notification@master\n  if: always()\n  with:\n    type: ${{ job.status }}\n    job_name: '*Lint Check*'\n    mention: 'here'\n    mention_if: 'failure'\n    channel: '#random'\n    url: ${{ secrets.ROCKETCHAT_WEBHOOK }}\n```\n\n↓ Including the latest commit data\n\n```..github/workflows/example2.yml\n- name: Rocket.Chat Notification\n  uses: RocketChat/Rocket.Chat.GitHub.Action.Notification@master\n  if: always()\n  with:\n    type: ${{ job.status }}\n    job_name: '*Lint Check*'\n    mention: 'here'\n    mention_if: 'failure'\n    channel: '#random'\n    url: ${{ secrets.ROCKETCHAT_WEBHOOK }}\n    commit: true\n    token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n# Rocket.Chat UI Example\n\n\u003cimg src=\"./images/rocketchat.png\" alt=\"Notification Preview\" width=\"90%\"\u003e\n\n# Contribute\n1. Fork this repository\n2. Pull your repository in local machine\n3. Update original repository\n4. Checkout \"master\" branch based \"remotes/origin/master\" branch\n5. Work on \"master\" branch\n6. Push you changes to your repository\n7. Create a new Pull Request\n\n# LICENSE\n\n[The MIT License (MIT)](https://github.com/RocketChat/Rocket.Chat.GitHub.Action.Notification/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRocketChat%2FRocket.Chat.GitHub.Action.Notification","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRocketChat%2FRocket.Chat.GitHub.Action.Notification","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRocketChat%2FRocket.Chat.GitHub.Action.Notification/lists"}