{"id":22421788,"url":"https://github.com/hugoalh/send-guilded-webhook-ghaction","last_synced_at":"2025-03-27T05:18:21.419Z","repository":{"id":263725301,"uuid":"891293680","full_name":"hugoalh/send-guilded-webhook-ghaction","owner":"hugoalh","description":"A GitHub Action to send Guilded webhook.","archived":false,"fork":false,"pushed_at":"2025-03-25T08:58:29.000Z","size":55,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T09:47:43.594Z","etag":null,"topics":["gh-action","ghaction","github-action","guilded","webhook"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/send-guilded-webhook","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hugoalh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-20T04:26:21.000Z","updated_at":"2025-02-10T09:50:38.000Z","dependencies_parsed_at":"2024-11-20T05:25:15.266Z","dependency_job_id":"dd9e524c-f44e-485a-8706-ed4e4713c9e7","html_url":"https://github.com/hugoalh/send-guilded-webhook-ghaction","commit_stats":null,"previous_names":["hugoalh/send-guilded-webhook-ghaction"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugoalh%2Fsend-guilded-webhook-ghaction","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugoalh%2Fsend-guilded-webhook-ghaction/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugoalh%2Fsend-guilded-webhook-ghaction/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugoalh%2Fsend-guilded-webhook-ghaction/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hugoalh","download_url":"https://codeload.github.com/hugoalh/send-guilded-webhook-ghaction/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245785805,"owners_count":20671634,"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":["gh-action","ghaction","github-action","guilded","webhook"],"created_at":"2024-12-05T17:09:34.149Z","updated_at":"2025-03-27T05:18:21.401Z","avatar_url":"https://github.com/hugoalh.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Send Guilded Webhook (GitHub Action)\n\n[**⚖️** MIT](./LICENSE.md)\n\n[![GitHub: hugoalh/send-guilded-webhook-ghaction](https://img.shields.io/github/v/release/hugoalh/send-guilded-webhook-ghaction?label=hugoalh/send-guilded-webhook-ghaction\u0026labelColor=181717\u0026logo=github\u0026logoColor=ffffff\u0026sort=semver\u0026style=flat \"GitHub: hugoalh/send-guilded-webhook-ghaction\")](https://github.com/hugoalh/send-guilded-webhook-ghaction)\n\nA GitHub Action to send Guilded webhook.\n\n\u003e [!IMPORTANT]\n\u003e - This documentation is v0.1.0 based; To view other version's documentation, please visit the [versions list](https://github.com/hugoalh/send-guilded-webhook-ghaction/tags) and select the correct version.\n\n## 🌟 Features\n\n- Support attachments/files.\n\n## 🔰 Begin\n\n### 🎯 Targets\n\n|  | **GitHub** |\n|:--|:--|\n| **[GitHub Actions Runner](https://github.com/actions/runner)** | [✔️ Docker](https://docs.github.com/en/actions) |\n\n\u003e [!NOTE]\n\u003e - It is possible to use this action in other methods/ways which not listed in here, however those methods/ways are not officially supported, and should beware maybe cause security issues.\n\n### #️⃣ Resources Identifier\n\n- **GitHub:**\n  ```\n  hugoalh/send-guilded-webhook-ghaction[@{Tag}]\n  ```\n\n\u003e [!NOTE]\n\u003e - It is recommended to use this action with tag for immutability.\n\n### 🛡️ GitHub Token Permissions\n\n*This action does not request any GitHub token permission.*\n\n## 🧩 Inputs\n\nAlmost all of the inputs are optional, but these groups of inputs must be defined:\n\n- [`key`](#key)\n- [`content`](#content), [`embeds`](#embeds), and/or [`files`](#files)\n\n\u003e | **Legend** | **Description** |\n\u003e |:-:|:--|\n\u003e | 🔐 | Should be an encrypted secret. |\n\n### `key`\n\n**🔐** `\u003cstring\u003e` Guilded webhook key; These syntaxes are acceptable:\n\n- **Webhook ID \u0026 Token:** `{webhook.id}/{webhook.token}`\n- **URL:** `https://media.guilded.gg/webhooks/{webhook.id}/{webhook.token}`\n\n### `username`\n\n`\u003cstring\u003e` Override the default webhook username, maximum 80 characters.\n\n### `avatar_url`\n\n`\u003cstring\u003e` Override the default webhook avatar, only support URL of HTTP and HTTPS.\n\n### `content`\n\n`\u003cstring\u003e` Message content, maximum 2000 characters; Support Guilded Markdown.\n\n### `content_links_no_embed`\n\n`\u003cRegExp[]\u003e` Links' regular expressions to prevent Guilded resolve and display matches links in the [`content`](#content) as embed under the message, only support URL of HTTP and HTTPS, separate each value per line.\n\nExamples:\n\n- **All:** `.+`\n- **`.png` Image:** `\\.png(?:\\?|#|$)`\n- **`.webp` Image:** `\\.webp(?:\\?|#|$)`\n- **Twitch:** `twitch\\.tv`\n\n### `embeds`\n\n`\u003cobject[]\u003e` Message embed rich content, by JSON or YAML with restricted syntaxes, maximum 10 embeds, and maximum 6000 characters for summation from inputs:\n\n- [`embeds[*].title`](#embedstitle)\n- [`embeds[*].description`](#embedsdescription)\n- [`embeds[*].footer.text`](#embedsfootertext)\n- [`embeds[*].author.name`](#embedsauthorname)\n- [`embeds[*].fields[*].name`](#embedsfieldsname)\n- [`embeds[*].fields[*].value`](#embedsfieldsvalue)\n\n#### `embeds[*].title`\n\n`\u003cstring\u003e` Message embed title, maximum 256 characters; Support Guilded Markdown.\n\n#### `embeds[*].description`\n\n`\u003cstring\u003e` Message embed description, maximum 4096 characters; Support Guilded Markdown.\n\n#### `embeds[*].url`\n\n`\u003cstring\u003e` Message embed URL.\n\n#### `embeds[*].timestamp`\n\n`\u003cstring\u003e` Message embed timestamp, by ISO 8601 format (e.g.: `\"2011-11-11T11:11:11Z\"`).\n\n#### `embeds[*].color`\n\n`\u003cnumber | string = 2105893\u003e` Message embed colour (i.e.: left border's colour of the embed); These syntaxes are acceptable:\n\n- **RGB Integer:** `{number}` (e.g.: `2105893`)\n- **Hex:** `#{hex}{hex}{hex}` / `#{hex}{hex}{hex}{hex}{hex}{hex}` (e.g.: `#0063B1`)\n- **Namespace:** (e.g.: `Blue`)\n- **CSS:** (e.g.: `rgb(32, 34, 37)`)\n- **Random:** `Random`\n\n\u003e [!NOTE]\n\u003e - Alpha channel is not supported.\n\u003e - General namespace are provided by NPM package [`color-name-list`](https://www.npmjs.com/package/color-name-list), list maybe change or remove without any notification, it is recommended to use value instead.\n\n#### `embeds[*].footer`\n\n`\u003cobject\u003e` Message embed footer.\n\n#### `embeds[*].footer.text`\n\n`\u003cstring\u003e` Message embed footer text, maximum 2048 characters; Support Guilded Markdown.\n\n#### `embeds[*].footer.iconUrl`\n\n`\u003cstring\u003e` Message embed footer icon, only support URL of HTTP, HTTPS, and attachments.\n\n#### `embeds[*].image`\n\n`\u003cobject\u003e` Message embed image.\n\n#### `embeds[*].image.url`\n\n`\u003cstring\u003e` Message embed image URL, only support URL of HTTP, HTTPS, and attachments.\n\n#### `embeds[*].thumbnail`\n\n`\u003cobject\u003e` Message embed thumbnail.\n\n#### `embeds[*].thumbnail.url`\n\n`\u003cstring\u003e` Message embed thumbnail URL, only support URL of HTTP, HTTPS, and attachments.\n\n#### `embeds[*].author`\n\n`\u003cobject\u003e` Message embed author.\n\n#### `embeds[*].author.name`\n\n`\u003cstring\u003e` Message embed author name, maximum 256 characters.\n\n#### `embeds[*].author.url`\n\n`\u003cstring\u003e` Message embed author URL.\n\n#### `embeds[*].author.iconUrl`\n\n`\u003cstring\u003e` Message embed author icon, only support URL of HTTP, HTTPS, and attachments.\n\n#### `embeds[*].fields`\n\n`\u003cobject[]\u003e` Message embed fields, maximum 25 fields.\n\n#### `embeds[*].fields[*].name`\n\n`\u003cstring\u003e` Message embed field name, maximum 256 characters; Support Guilded Markdown.\n\n#### `embeds[*].fields[*].value`\n\n`\u003cstring\u003e` Message embed field value, maximum 1024 characters; Support Guilded Markdown.\n\n#### `embeds[*].fields[*].inline`\n\n`\u003cboolean = false\u003e` Whether the message embed field should display inline.\n\n### `files`\n\n`\u003cstring[]\u003e` Message attachments/files, by Glob path or literal path (select by input [`files_glob`](#files_glob)) under the workspace, separate each value per line, maximum 8 MB and 10 files.\n\n### `files_glob`\n\n`\u003cboolean = true\u003e` Whether input [files](#files) should accept Glob path instead of literal path.\n\n### `truncate_enable`\n\n`\u003cboolean = true\u003e` Whether to try truncate firstly when inputs are too large.\n\n### `truncate_ellipsis`\n\n`\u003cstring = \"...\"\u003e` Ellipsis mark.\n\n### `truncate_position`\n\n`\u003cstring = \"end\"\u003e` Ellipsis position.\n\n- **`\"end\"`:** At the end of the string.\n- **`\"middle\"`:** At the middle of the string.\n- **`\"start\"`:** At the start of the string.\n\n## 🧩 Outputs\n\n### `response`\n\n`\u003cstring\u003e` Response content.\n\n### `status_code`\n\n`\u003cnumber\u003e` Request status code.\n\n### `status_ok`\n\n`\u003cboolean\u003e` Whether the request was successful.\n\n### `status_text`\n\n`\u003cstring\u003e` Request status text.\n\n## ✍️ Examples\n\n- Hello, world!\n  ```yml\n  jobs:\n    job_id:\n      name: \"Send Guilded Webhook\"\n      runs-on: \"ubuntu-latest\"\n      steps:\n        - uses: \"hugoalh/send-guilded-webhook-ghaction@v0.1.0\"\n          with:\n            key: \"${{secrets.GUILDED_WEBHOOK_KEY}}\"\n            content: \"Hello, world!\"\n  ```\n\n## 📚 Guides\n\n- GitHub Actions\n  - [Enabling debug logging](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging)\n  - [Encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets)\n- Guilded\n  - [Execute Webhook](https://guildedapi.com/resources/webhook/#execute-webhook)\n  - [Incoming Webhooks](https://support.guilded.gg/hc/en-us/articles/360038927934-Incoming-Webhooks)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugoalh%2Fsend-guilded-webhook-ghaction","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhugoalh%2Fsend-guilded-webhook-ghaction","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugoalh%2Fsend-guilded-webhook-ghaction/lists"}