{"id":16900262,"url":"https://github.com/ilshidur/action-discord","last_synced_at":"2025-05-14T22:07:08.673Z","repository":{"id":36600690,"uuid":"165749165","full_name":"Ilshidur/action-discord","owner":"Ilshidur","description":"🚀 GitHub Action that sends a Discord message.","archived":false,"fork":false,"pushed_at":"2025-04-11T03:47:24.000Z","size":170,"stargazers_count":434,"open_issues_count":34,"forks_count":82,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-05-14T07:35:30.475Z","etag":null,"topics":["github-action","github-actions"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/actions-for-discord","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/Ilshidur.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,"zenodo":null}},"created_at":"2019-01-14T23:03:36.000Z","updated_at":"2025-05-14T00:03:07.000Z","dependencies_parsed_at":"2023-11-10T15:24:24.247Z","dependency_job_id":"72cbce2f-1ede-480c-bdbe-f1377d44b6d4","html_url":"https://github.com/Ilshidur/action-discord","commit_stats":{"total_commits":80,"total_committers":11,"mean_commits":"7.2727272727272725","dds":0.5625,"last_synced_commit":"08d9328877d6954120eef2b07abbc79249bb6210"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ilshidur%2Faction-discord","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ilshidur%2Faction-discord/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ilshidur%2Faction-discord/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ilshidur%2Faction-discord/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ilshidur","download_url":"https://codeload.github.com/Ilshidur/action-discord/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254235695,"owners_count":22036963,"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-action","github-actions"],"created_at":"2024-10-13T17:52:26.031Z","updated_at":"2025-05-14T22:07:03.646Z","avatar_url":"https://github.com/Ilshidur.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚀 Discord for GitHub Actions\n\n[![Build Status][build-badge]][build-url]\n\nSends a Discord notification message. Simple as that.\nSupports all [workflow event types](https://developer.github.com/webhooks/#events) by using the [Discord GitHub webhooks](https://discordapp.com/developers/docs/resources/webhook#execute-githubcompatible-webhook).\n\n*Appearance on Discord :*\n\n![Discord message](preview.png \"Discord message\")\n\nThis GitHub action is part of a list of Actions that are located in an other repo. Feel free to check it out : https://github.com/Ilshidur/actions.\n\n## Compatibility note\n\nAs this Action is containerized with Docker, [it can only run on Linux environments](https://help.github.com/en/actions/building-actions/about-actions#types-of-actions).\n\n\u003e Docker container actions can only execute in the GitHub-hosted Linux environment.\n\u003e Self-hosted runners must use a Linux operating system and have Docker installed to run Docker container actions. For more information about the requirements of self-hosted runners, see \"About self-hosted runners.\"\n\n\u003chr/\u003e\n\n## Usage\n\n```yaml\n- name: Discord notification\n  env:\n    DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}\n  uses: Ilshidur/action-discord@master\n  with:\n    args: 'The project {{ EVENT_PAYLOAD.repository.full_name }} has been deployed.'\n```\n\n**NOTICE :** for stability purposes, it is recommended to use the action with an explicit commit SHA-1 :\n\n* Version : `uses: \"Ilshidur/action-discord@0.3.2\"` (\u0026rarr; link to the releases list : https://github.com/Ilshidur/action-discord/releases)\n* Commit SHA-1 : `uses: \"Ilshidur/action-discord@0c4b27844ba47cb1c7bee539c8eead5284ce9fa9\"` (\u0026rarr; link to the commits list : https://github.com/Ilshidur/action-discord/commits/master)\n\n### Arguments\n\nBy default, the GitHub action will send a notificaction with the event informations. Providing the arguments will override the message.\n\n**Environment variables** can be interpolated in the message using brackets (`{{` and `}}`) :\n\ne.g.: `Action called : {{ GITHUB_ACTION }}`\n\n**Event Payload** data can also be interpolated in the message using brackets (`{{` and `}}`) with the `EVENT_PAYLOAD` variable.\n\ne.g.: `Action called: {{ GITHUB_ACTION }} as {{ EVENT_PAYLOAD.pull_request.id }}`\n\n\u003e See the [event types](https://developer.github.com/v3/activity/events/types) for valid payload informations.\n\n#### Examples\n\n* `args = \"Hello, beautiful ! I ran a GitHub Actions for you \u003c3\"`\n* `args = \"I showed you my commit. Please respond.\"`\n\n### Environment variables\n\n* **`DISCORD_WEBHOOK`** (**required**): the Discord webhook URL (see https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks).\n  * ***IMPORTANT !!* You MUST NOT append `/github` at the end of the webhook.**\n* **`DISCORD_USERNAME`** (*optional*): overrides the bot nickname.\n* **`DISCORD_AVATAR`** (*optional*): overrides the avatar URL.\n* **`DISCORD_EMBEDS`** (*optional*): This should be a valid JSON string of an array of Discord `embed` objects. See the [documentation on Discord WebHook Embeds](https://birdie0.github.io/discord-webhooks-guide/structure/embeds.html) for more information. You can use set it to `${{ toJson(my_value) }}` using [`toJson()`](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#tojson) if your input is an object value.\n* That's all.\n\n## Alternatives\n\nBecause open source is about everyone :\n\nhttps://github.com/marketplace/actions/discord-message-notify \u003cbr/\u003e\n![](https://img.shields.io/github/stars/appleboy/discord-action.svg?label=Stars\u0026style=social)\n\n## TODO\n\n* [Pass arguments with the `with` keyword](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepswith)\n* Run outside of a container.\n\n\u003chr/\u003e\n\n\u003cp align=\"center\"\u003e\n  Don't forget to 🌟 Star 🌟 the repo if you like this GitHub Action !\u003cbr/\u003e\n  \u003ca href=\"https://github.com/Ilshidur/action-discord/issues/new\"\u003eYour feedback is appreciated\u003c/a\u003e\n\u003c/p\u003e\n\n[build-badge]: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FIlshidur%2Faction-discord%2Fbadge\u0026style=flat\n[build-url]: https://actions-badge.atrox.dev/Ilshidur/action-discord/goto\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filshidur%2Faction-discord","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Filshidur%2Faction-discord","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filshidur%2Faction-discord/lists"}