feat: Support transparent/dynamic embed color

[KobeW50]

Discord embeds can have a semi-transparent color that appears different based on the user's theme:

The webhook messages in the images above were generated on discohook.org, which uses this transparent color by default.

According to this guide, an embed's color is transparent by default (set to 0).

Similarly, this doc, says that to use the "default" embed color in Discord, the hex code should be 0x000000 or an integer value should be 0.

But currently, when using this GitHub action, if the color is set to 0x000000, 0, 0x0, 0x00000000, or 000000 the color will end up being green:

Feature

Add support to specify this transparent embed color.

[sarisia]

Wow, I didn't even know color=0 is valid value...

Let me fix this. Thank you for reporting!

[sarisia]

This is released as https://github.com/sarisia/actions-status-discord/releases/tag/v1.14.7, thanks!

[KobeW50]

Thank you! Uhh, I am having trouble using it:

I tried color: 0x000000 and color: 0 but both led to pure black (not transparent). At least it is not green :)

From the log it seems that it was sent correctly as 0. (Ignore the 0x000000 in the log. That's just the release tag name.)

So is the default color mentioned in the docs not the transparent one? I am really sorry.

[KobeW50]

Update: I asked in the Discohook Discord server, and this is what an admin said

I'm really sorry. I thought it had to be zero.

When trying to specify the color as color: null or color: 'null', the result is that the payload will be "color": 2664261, (green) instead of "color": null.

This is what is seen in the json data editor that the admin mentions:

{
  "content": null,
  "embeds": [
    {
      "description": "`\"color\": 0`",
      "color": 0
    },
    {
      "description": "`\"color\": null`",
      "color": null
    }
  ],
  "attachments": []
}

[sarisia]

Oh, got your point.

I'm not sure what Discohook is but atm we do not have ways to set color: null
and since this action aims to easier usage for reporting GitHub Actions result, we have no
plans to support it.

Maybe it's good to have GitHub Actions outputs to expose webhook payload json to latter steps
to help implementing custom solutions, WDYT?

[KobeW50]

Maybe it's good to have GitHub Actions outputs to expose webhook payload json to latter steps
to help implementing custom solutions, WDYT?

Uhh, tbh I don't really understand what this would mean. Is this like being able to fully customize the payload json? If yes, it sounds cool, but only do what makes sense. I do not want you do to anything unreasonable.

[sarisia]

Let's say we add the output payload to this action, then we can:

- uses: actions-status-discord@v1
  id: webhook
- run: npm install axios
- uses: actions/github-script@v7
  env:
    WEBHOOK_PAYLOAD: ${{ steps.webhook.outputs.payload }}
    WEBHOOK_URL: ${{ secrets.DISCORD_WEBHOOK }}
  with:
    script: |
      const axios = require("axios")
      const { WEBHOOK_PAYLOAD, WEBHOOK_URL } = process.env

      const payload = JSON.parse(WEBHOOK_PAYLOAD)
      payload.embeds[0].color = null

      axios.post(WEBHOOK_URL, payload)

[KobeW50]

I can't code but ChaptGPT helped me understand this 🙈 (this is my first time using a Gh action)

This is clever, but tbh, I imagine very few users would be interested or be able to utilize this capability so idk if it's worth implementing.

Edit: The dev of Dischook said this, if it makes any difference:

[sarisia]

I've made an pre-release as https://github.com/sarisia/actions-status-discord/releases/tag/v1.15.0-pre.0 .
You can use pre-release like: uses: sarisia/[email protected].

Also see https://github.com/sarisia/actions-status-discord/tree/output-payload?tab=readme-ov-file#full-payload-control for usages.

I'll make it official once other implementations are done.

[KobeW50]

Thank you!

Do you accept donations? (I couldn't find anything on any of your profiles)

[sarisia]

No worries at all but if this doesn't bother you, I have sponsor button on top of repository, thanks!

https://github.com/sponsors/sarisia

[sarisia]

This is now released as v1.15.0!