interactive-inputs-action/action.yml at main · NivEz/interactive-inputs-action · 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
name: 'Interactive Inputs Action'
description: 'Github actions interacrive inputs using Telegram bot'
author: 'Niv Ezra'
inputs:
  telegram-api-token:
    description: 'Telegram API token'
    required: true
  telegram-chat-id:
    description: 'The Telegram chat id that will be used for the interactive inputs and messages'
    required: true
  question:
    description: 'The question / statement that will be used in Telegram followed with buttons (each button represents one of the options)'
  options:
    description: 'The possible options (buttons) that will appear as the interactive inputs in Telegram - represented as a JSON array of strings'
    default: '[]'
  default-choice:
    description: 'Default choice that will be used if the user did not choose any of the options in Telegram'
  message:
    description: 'Message that will be sent thorugh Telegram after the user interaction has finished. It is possible to use %s as a variable that will be replaced with the selected choice'
    default: 'The selected choice is: %s'
  timeout:
    description: 'Timeout in seconds for selecting one of the possible options. When the timeout exceeds - stopping to check for updates from Telegram'
    default: 60
  timeout-message:
    description: 'Message that will be sent to Telegram if the timeout exceeds and the user did not select any of the options'
    default: 'Timeout exceeded without any choice...'
  is-choosing-required:
    description: 'If true - the user must choose one of the options - in case the user did not choose and there is no default choice - the timeout message will be sent and the run will be cancelled'
    default: true
  wait-for-timeout-to-finish:
    description: 'If true - the run will wait for the timeout to finish even if the user already chose one of the options - that will let the user to change his choice before the timeout exceeds'
    default: false
  simple-message:
    description: 'Just a simple message that will be sent through Telegram without any of the functionality of interactive inputs'
outputs:
  user-choice:
    description: 'The selected choice recieved from Telegram'
runs:
  using: 'node20'
  main: 'dist/index.js'

branding:
  icon: check-square
  color: blue