{"id":17675608,"url":"https://github.com/ernanej/action-discord-alerts","last_synced_at":"2025-04-16T07:42:54.346Z","repository":{"id":161815746,"uuid":"636448765","full_name":"ErnaneJ/action-discord-alerts","owner":"ErnaneJ","description":"Action aimed at facilitating continuous delivery. You only need a Discord webhook to receive notifications for the completion status of your workflow. 🎉","archived":false,"fork":false,"pushed_at":"2023-05-07T20:43:07.000Z","size":373,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T05:12:25.614Z","etag":null,"topics":["actions","ci","discord","webhooks"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/action-discord-alerts","language":"JavaScript","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/ErnaneJ.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["ernanej"]}},"created_at":"2023-05-04T21:51:16.000Z","updated_at":"2024-09-04T21:36:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"5f46e5c2-4973-48ff-a09c-9d9500fad8a9","html_url":"https://github.com/ErnaneJ/action-discord-alerts","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ErnaneJ%2Faction-discord-alerts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ErnaneJ%2Faction-discord-alerts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ErnaneJ%2Faction-discord-alerts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ErnaneJ%2Faction-discord-alerts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ErnaneJ","download_url":"https://codeload.github.com/ErnaneJ/action-discord-alerts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249214015,"owners_count":21231096,"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":["actions","ci","discord","webhooks"],"created_at":"2024-10-24T07:22:52.211Z","updated_at":"2025-04-16T07:42:54.322Z","avatar_url":"https://github.com/ErnaneJ.png","language":"JavaScript","funding_links":["https://github.com/sponsors/ernanej"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cstrong\u003eAction Discord Alerts 📢\u003c/strong\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#-project\"\u003eProject\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#-use\"\u003eUse\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#-arguments\"\u003eArguments\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#-test\"\u003eTest\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#-build\"\u003eBuild\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#-contribute\"\u003eContribute\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\n\u003c/p\u003e\n\n\u003cbr/\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/ErnaneJ/action-discord-alerts/actions/workflows/ci.yaml\"\u003e\n    \u003cimg src=\"https://github.com/ErnaneJ/action-discord-alerts/actions/workflows/ci.yaml/badge.svg\" alt=\"CI\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Preview\" src=\"./imgs/preview.png\"\u003e\n\u003c/p\u003e\n\n## 💻 Project\n\nAction aimed at facilitating continuous delivery. You only need a discord webhook to track the completion status of your workflow.\n\n## 🚀 Use\n\n```yml\n  # ...\n  - name: Action Discord Alert\n    if: always()\n    uses: ErnaneJ/action-discord-alerts@main\n    with:\n      webhook: ${{ secrets.DISCORD_WEBHOOK }}     \n      status: ${{ job.status }}\n```\n\n## 📑 Arguments\n\n| Argument       | Required  | Default               | Description                                                                                                                              |\n|-----------------|-----------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| **webhook**     |  `true`   | -                     | Discord webhook.                                                                                                                         |\n| **status**      |  `false`  | `${{ job.status }}`     | Job status. Should be bound to job.status. Default to success.                                                                           |\n| **content**     |  `false`  | -                     | Standard message outside the information card. Can be used to mention users.                                                             |\n| **title**       |  `false`  | -                     | For custom title only. By default it is filled with action job status.                                                                   |\n| **description** |  `false`  | -                     | For custom description only. By default it is filled with author and commit message.                                                     |\n| **image**       |  `false`  | -                     | Url of an Image that will be attached to the information card                                                                            |\n| **thumbnail**   |  `false`  | -                     | Url of an thumbnail that will be attached to the information card                                                                        |\n| **color**       |  `false`  | -                     | Overwrite the defined color for the info card highlight. By default this color is set by job status.                                     |\n| **username**    |  `false`  | -                     | Overrides Discord webhook username. By default we have Github Action.                                                                    |\n| **avatar_url**  |  `false`  | -                     | Overrides Discord webhook avatar url. By default we have Github image url.                                                               |\n| **event_info**  |  `false`  | `true`                | Decide whether or not to display drill-downs for some information. By default it is shown.                                               |\n| **timestamp**   |  `false`  | `true`                | Controls whether to show the timestamp on the info card. Default pos is shown.                                                           |\n| **verbose**     |  `false`  | `false`               | Controls the sampling of some information when the script runs. For example, the payload that is assembled before being sent to discord. |\n\n## 💡 Test\n\nThe tests use Jest. To run them use:\n\n```bash\nnpm run test\n\n# To hide warnings set the silent environment variable.\nexport SILENT=true\n```\n\n## 🔥 Build\n\n```bash\nnpm run build # use @vercel/ncc\n```\n\n## 🎉 Contribute\n\nIf you would like to implement or improve any feature feel free to submit a pull request. I would love to receive!\n\n\u003chr/\u003e\n\n\u003cp align=\"center\"\u003e\n  Developed with ❤ by \u003ca target=\"_blank\" href=\"https://ernanej.github.io/my-linktree/\"\u003eErnane Ferreira\u003c/a\u003e. 👋🏻\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fernanej%2Faction-discord-alerts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fernanej%2Faction-discord-alerts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fernanej%2Faction-discord-alerts/lists"}