bitrise-step-microsoft-teams-adaptive-card/step.yml at master · lovoo/bitrise-step-microsoft-teams-adaptive-card · 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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
#
# A couple of useful guides & docs:
#
# - Main Bitrise CLI docs: https://github.com/bitrise-io/bitrise/tree/master/_docs
# - Step Development Guideline: https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md
# - Bitrise.yml format spec: https://github.com/bitrise-io/bitrise/blob/master/_docs/bitrise-yml-format-spec.md
# - Bitrise docs: http://devcenter.bitrise.io/
# - Bitrise CLI guides: http://devcenter.bitrise.io/bitrise-cli/

title: |-
  Microsoft Teams Adaptive Card Integration
summary: |
  Send Microsoft Teams message to a channel
description: |
  Send Microsoft Teams message as adaptive card
website: https://github.com/HUK-COBURG/bitrise-step-microsoft-teams-adaptive-card
source_code_url: https://github.com/HUK-COBURG/bitrise-step-microsoft-teams-adaptive-card
support_url: https://github.com/HUK-COBURG/bitrise-step-microsoft-teams-adaptive-card/issues
host_os_tags:
  - osx-10.10
  - ubuntu-16.04
type_tags:
  - notification

is_requires_admin_user: false
is_always_run: true
is_skippable: true

toolkit:
  go:
    package_name: github.com/HUK-COBURG/bitrise-step-microsoft-teams-adaptive-card


inputs:
# Settings Inputs
  - is_debug_mode: "no"
    opts:
      title: "Debug mode?"
      description: |
        Step prints additional debug information if this option
        is enabled
      value_options:
      - "yes"
      - "no"
  - webhook_url:
    opts:
      title: "Microsoft Teams Webhook URL"
      description: |
        Microsoft Teams Webhook URL
      is_required: true
      is_sensitive: true
# Message Main Inputs
  - card_headline: "Success"
    opts:
      title: "Adaptive Card Header Container text"
      description: |
        Text of the header container.
  - card_headline_on_error: "Failed"
    opts:
      title: "Adaptive Card Header Container text"
      description: |
        Text of the header container.
      category: If Build Failed
  - card_style: "good"
    opts:
      title: "Adaptive Card Style"
      description: |
        Specifies the color of the header container.
        For preview see:
        [documentation of Adaptive Cards](https://adaptivecards.io/designer/).
      value_options:
        - "default"
        - "good"
        - "attention"
        - "warning"
        - "accent"
        - "emphasis"
  - card_style_on_error: "attention"
    opts:
      title: "Message card theme color if the build failed"
      description: |
        **This option will be used if the build failed.**
      category: If Build Failed
      value_options:
        - "default"
        - "good"
        - "attention"
        - "warning"
        - "accent"
        - "emphasis"
  - title: "Build Succeeded!"
    opts:
      title: "Message card title"
      description: |
        The `title` property is meant to be rendered in a prominent way, at the very top of the card.
        Use it to introduce the content of the card in such a way users will immediately know what to expect.
  - title_on_error: "Build Failed!"
    opts:
      title: "Message card title if the build failed"
      description: |
        **This option will be used if the build failed.**
      category: If Build Failed
# Message Git Inputs
  - author_name: $GIT_CLONE_COMMIT_AUTHOR_NAME
    opts:
      title: "A small text used to display the author's name."
      description: "A small text used to display the author's name."
  - subject: $GIT_CLONE_COMMIT_MESSAGE_SUBJECT
    opts:
      title: "A small text used to display the subject."
      description: "A small text used to display the subject."
# Message Content Inputs
  - fields: |
      App|${BITRISE_APP_TITLE}
      Workflow|${BITRISE_TRIGGERED_WORKFLOW_ID}
      Branch|${BITRISE_GIT_BRANCH}
      Tag|${BITRISE_GIT_TAG}
      Message|${BITRISE_GIT_MESSAGE}
    opts:
      title: "A list of fields to be displayed in a section"
      description: |
        Fields separated by newlines and each field contains a `title` and a `value`.
        The `title` and the `value` fields are separated by a pipe `|` character.
        Empty lines and lines without a separator are omitted.

        The *title* shown as a bold heading above the `value` text.
        The *value* is the text value of the field.
  - images:
    opts:
      title: "A list of images to be displayed in a section"
      description: |
        Fields separated by newlines and each image contains a `title` and a `url`.
        The `title` and the `url` fields are separated by a pipe `|` character.
        Empty lines and lines without a separator are omitted.

        The *image url* is shown.
  - images_on_error:
    opts:
      title: "A list of images to be displayed in a section if the build failed"
      description: |
        Fields separated by newlines and each image contains a `title` and a `url`.
        The `title` and the `url` fields are separated by a pipe `|` character.
        Empty lines and lines without a separator are omitted.

        The *image url* is shown.
      category: If Build Failed
  - buttons: |
      View App|${BITRISE_APP_URL}
      View Build|${BITRISE_BUILD_URL}
      Install Page|${BITRISE_PUBLIC_INSTALL_PAGE_URL}
    opts:
      title: "A list of buttons attached to the message as link buttons"
      description: |
        Buttons separated by newlines and each field contains a `text` and a `url`.
        The `text` and the `url` fields are separated by a pipe `|` character.
        Empty lines and lines without a separator are omitted.

        The *text* is the label for the button.
        The *url* is the fully qualified http or https url to deliver users to.

        An attachment may contain 1 to 4 buttons.
  - buttons_on_error: |
      View App|${BITRISE_APP_URL}
      View Build|${BITRISE_BUILD_URL}
      Install Page|${BITRISE_PUBLIC_INSTALL_PAGE_URL}
    opts:
      title: "A list of buttons attached to the message as link buttons if the build failed"
      description: |
        Buttons separated by newlines and each field contains a `text` and a `url`.
        The `text` and the `url` fields are separated by a pipe `|` character.
        Empty lines and lines without a separator are omitted.

        The *text* is the label for the button.
        The *url* is the fully qualified http or https url to deliver users to.

        An attachment may contain 1 to 4 buttons.
      category: If Build Failed