discord-webhook-notify/action.yml at main · rjstone/discord-webhook-notify · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
name: Discord Webhook Notify
author: rjstone
description: >
  Send notifications to Discord using a webhook.
  Works with all execution environments including windows, macos, and linux.
inputs:
  webhookUrl:
    description: >
      Discord webhook URL. Should be stored in a repo secret (Settings>Security>Secrets) and inserted
      in the action call as a context expression.
    required: true
  flags:
    description: >
      A whitespace-separated list of MessageFlags. The only one supported currently is SuppressNotifications.
    required: false
    default: ""
  username:
    description: >
      Username to display in discord. Must be 2-32 chars long and can't contain: @, #, :, ```, discord
      Also can't be "here" or "everyone", for obvious reasons.
    required: false
    default: "Notification (Github Actions)"
  avatarUrl:
    description: >
      URL to png of discord avatar to use. Default is the GitHub monochrome mark cat logo.
      May not work depending on Discord policy.
    required: false
    default: https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png
  text:
    description: Text to be sent as normal text above the embed. Defaults to empty string.
    required: false
  severity:
    description: >
      Severity level - info, warn, error, or none. Using "none" will cause no embed to be added.
      Using any other value will cause an embed with a set of matching defaults to be added.
    required: false
    default: none
  color:
    description: "Notification embed color in the form #rrggbb (hex). Default determined by severity."
    required: false
  title:
    description: Title for the embed. Defaults to severity long terminology.
    required: false
  description:
    description: Embed notification message. Default provides some minimal github.context workflow info.
    required: false
  details:
    description: >
      Additional text after the description in case you want to retain the default embed description.
      Defaults to empty string.
    required: false
  footer:
    description: Footer for the embed. Defaults to long terminology severity.
    required: false
  processingOptions:
    description: >
      (EXPERIMENTAL) Set to "percentDecode" if you want some inputs that are
      often multi-line strings to be run through "percent decoding" using
      decodeURIComponent(). This can be useful in cases where the output from
      another action should contain newlines, but won't be preserved by the
      Workflow system if it does.
    required: false
    default: ""
  holddownTime:
    description: >
      The minimum amount of time in miliseconds between successive notifications to avoid triggering Discord's
      rate limiting.
    required: false
    default: "3000"
  lockfileDir:
    description: >
      The directory where the lockfile used for saving last run time is stored.
    required: false
    default: "."


runs:
  using: "node20"
  main: "dist/index.js"
branding:
  color: orange
  icon: alert-triangle