Sends messages to Microsoft Teams from within Concourse CI pipelines.
Implements the Microsoft Teams Connector protocols and the Concourse CI resource protocols.
Resolves at runtime Concourse CI environment variables referenced in your Teams connector messages such as:
$BUILD_ID
$BUILD_NAME
$BUILD_JOB_NAME
$BUILD_PIPELINE_NAME
$BUILD_TEAM_NAME
$ATC_EXTERNAL_URL
source
definition. The
example below creates an alert
resource. Each point in the pipeline labeled
alert
is a Microsoft Teams Connector message.resources:
- name: alert
type: teams-notification
source:
url: https://outlook.office365.com/webhook/blah-blah-blah [required]
proxy_url: https://my.corp.net [optional]
proxy_port: 1234 [optional]
proxy_username: myusername [optional]
proxy_password: mysecret [optional]
skip_cert_verification [optional]
verbose [optional]
silent [optional]
url
: Required. The webhook URL as provided by Teams when you add a
connection for "Incomming Webhook". Usually in the
form: https://outlook.office365.com/webhook/XXX
proxy_url
: Optional. Basic auth for forwarding proxies - prefix with protocol. ie: https://proxy_port
: Optional. Basic auth for forwarding proxiesproxy_username
: Optional. Basic auth for forwarding proxiesproxy_password
: Optional. Basic auth for forwarding proxiesskip_cert_verification
: Optional. cURL -k
option for debugging when behind TLS rewrite proxies when the internal cert is self-signed or not properly distributedverbose
: Optional. cURL -v
option for debugging silent
: Optional. cURL -s
option for no logging Next, define the non-built-in type:
resource_types:
- name: teams-notification
type: docker-image
source:
repository: navicore/teams-notification-resource
tag: v0.9.12
Example of an alert in a pull-request job:
- name: Test-Pull-Request
plan:
- get: {{mypipeline}}-pull-request
trigger: true
- task: test-pr
file: {{mypipeline}}-pull-request/pipeline/test-pr.yml
on_success:
put: alert
params:
text: |
pull request tested: success
title: {{mypipeline}} Pull Request Tested
actionName: {{mypipeline}} Pipeline
actionTarget: $ATC_EXTERNAL_URL/teams/$BUILD_TEAM_NAME/pipelines/$BUILD_PIPELINE_NAME/jobs/$BUILD_JOB_NAME/builds/$BUILD_NAME
on_failure:
put: alert
params:
color: EA4300
text: |
pull request tested: **WITH ERRORS**
title: {{mypipeline}} Pull Request Tested
actionName: {{mypipeline}} Pipeline
actionTarget: $ATC_EXTERNAL_URL/teams/$BUILD_TEAM_NAME/pipelines/$BUILD_PIPELINE_NAME/jobs/$BUILD_JOB_NAME/builds/$BUILD_NAME
text
: Required. Text of the message to send - markdown supported (higher precedence over text_file
)text_file
: Required. A location of text file of the message to send, usually an output from a previous task - markdown supportedtitle
: Optional.actionName
: Optional. Text on the button/link (shows up as a link though the Teams docs show a button)actionTarget
: Optional. URL to connect to the button/linkstyle
: Optional. Adaptive Card header style. Can be one of 'good', 'attention', 'warning'. If not provided, title
and text
are scanned for keywords to determine the style. If no keywords are found, 'default' is used.color
See *.yml
files in the directory.
Testing with docker-compose.
See working standalone docker-compose example in dir.
Proxy support testing is limited to squid4. Dev env was created with default squid4 setup.
sudo service squid start
sudo vim /etc/squid/squid.conf
sudo service squid restart
sudo service squid stop
We tested proxy support with squid4. We don't have access to a wide range of proxies.
The ntlm flag on cURL is not set in our implementation but squid4 was happy to call our session ntlm. We're open to PRs for more support of proxies.