Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexkvak/teamcity-slack

TeamCity Slack plugin
https://github.com/alexkvak/teamcity-slack

scala slack teamcity-plugin

Last synced: 3 months ago
JSON representation

TeamCity Slack plugin

Awesome Lists containing this project

README 

        
# TeamCity Slack plugin



[![Build Status](https://travis-ci.org/alexkvak/teamcity-slack.svg?branch=master)](https://travis-ci.org/alexkvak/teamcity-slack)



This plugin allows you to integrate your CI with Slack.



The main feature is that you can specify not exact branch name but the [regexp branch mask](#build-configuration).



For example, if you have separate build configurations for feature branches and common branches, then it is easy to

setup notifications into corresponding Slack channels.



The second big thing is that you can compose your own messages using [template placeholders](#message-placeholders) and [Slack formatting](https://api.slack.com/docs/message-formatting).



And you can easily send notifications without running the build with the *Try it* feature.



The plugin automatically backs up its settings after each modification.



![Successful build](_doc/build-success.png)

![Failed build](_doc/build-fail.png)

![Artifact links](_doc/artifact-links.png)



## Table of Contents

1. [Install plugin](#install-plugin)

2. [Build configuration](#build-configuration)

3. [Message placeholders](#message-placeholders)

4. [Artifact links](#artifact-links)

5. [Message preview](#message-preview)

6. [Proxy setup](#proxy-setup)

7. [Troubleshooting](#troubleshooting)



## Install plugin 

Download from [releases](https://github.com/alexkvak/teamcity-slack/releases) or compile 

sources with `mvn package`. 



Next upload `target/slackIntegration.zip` to TeamCity `data/plugins/` folder (restart is needed).



Create Slack App:

* Open [Create app](https://api.slack.com/apps) form and fill it

* Go to **OAuth & Permissions**. Add following scopes in **Scopes** section: `channels:read`, `chat:write`, `chat:write.public`, `groups:read`, `im:read`, `im:write`, `mpim:read`, `users:read`, `users:read.email`. If you plan to change sender name, add also `chat:write.customize` scope.

* Click **Install App in Workspace**

* Now copy **Bot User OAuth Token**.



Paste this token into **Administration -> Slack -> OAuth Access Token** field.



![Plugin setup](_doc/plugin-setup.png "Plugin setup")



That's it! Now you can open any build configuration home and choose **Slack** tab.



By default personal notifications (private notifications) are disabled. 

Personal notifications notify only about failed builds.



**Slack** tab in classic UI:

![Slack tab](_doc/slack-tab.png "Slack tab")



**Slack** tab in experimental UI:

![Slack tab](_doc/slack-tab-experimental-UI.png "Slack tab")

Only admins and projects admins have rights to access these settings. 



## Build configuration 



Sample configuration:



![Edit settings](_doc/edit-settings.png "Edit settings")



Notifications for branches captured by regular expression will be sent to slack channel or/and private chat.

Message will be compiled according to template.



**Note:** Please avoid using heading `#` in channel name.



The *Only trigger when build changes* option allows you to be notified when the previous build status changes from failure to success, or vice versa.

The previous build is the latest build on the same branch as the current build (or not if the current build has no branch), and

its status is determined (failure or success) and it's not a personal build.



The build settings number is not limited, so you can set up notifications for feature branches 

in one channel, and for release branches in another one.



## Message placeholders 



###### {name} 

Full name of the build configuration, has the format "project_name :: buildconfig_name".



###### {number}

User defined build number.



###### {branch}

Branch display name, i.e. name to show to the user. *Unknown* if not applicable.



Please make sure that your VCS settings are correct!



See [TeamCity Docs](https://confluence.jetbrains.com/x/iwt2B#WorkingwithFeatureBranches-Logicalbranchname) and [#21](https://github.com/alexkvak/teamcity-slack/issues/21)



###### {status}

*succeeded* if build is successful, *started* if started, *canceled* if canceled, *failed* otherwise.



###### {link}

URL to view results page.



###### {mentions}

Slack users mentions only if build fails. Unknown users will be skipped.



###### {users}

TeamCity user name list only if build fails. Unknown users will be skipped.



###### {changes}

Concatenated description of head 5 changes from build with author name (from VCS) 

in square braces, e.g. *My awesome feature [John Smith]*.



###### {reason}

Build problems that caused build failure when build is failed. *Unknown* if cannot detect.



###### {artifactLinks}

See [Artifact links](#artifact-links).



###### {allArtifactsDownloadUrl}

Link to download all artifacts as zip archive.



###### {artifactsRelUrl}

Artifacts relative path. It is necessary if you want to construct artifact link manually.



###### {formattedDuration}

Build duration in TeamCity format. 



###### Parameters placeholders

You can also use project and build parameters, e.g. *{%my.awesome.teamcity.param%}*



## Artifact links 

In case you want to access build artifacts with third party web server (e.g. nginx) you can use this feature.

Specify *Public artifacts URL* as root path served by your web server. 

And *Artifacts mask* in [Build configuration](#build-configuration).

All other will be done automatically.



Sample nginx configuration:

```

location /art/ {

    alias /system/artifacts/;

    autoindex on;

}

```



## Message preview 

By default Slack plugin sends messages as attachments. 

But there is one inconvenience — there is no message preview in push notifications. 

It can be easily fixed by turning off the *Send message as attachment* checkbox in [Plugin setup](#install-plugin).



Now Slack messages look like



![Successful build with emoji](_doc/build-success-emoji.png)



The message is prepended by Emoji ✅, ⛔ or ⚪ for successful, failed and other build statuses respectively.



## Proxy setup 

Plugin fist lookup for Slack only proxy setting than uses default Java proxy. You can set up proxy by specifying JVM properties:



```

# proxy specified only for Slack 

teamcity.slack.proxyHost=proxy.com

teamcity.slack.proxyPort=8888



# global JVM proxy

http.proxyHost=proxy.com

http.proxyPort=8888



# or

https.proxyHost=proxy.com

https.proxyPort=8888 

```



The second way is to set up TeamCity internal properties (see https://www.jetbrains.com/help/teamcity/configuring-teamcity-server-startup-properties.html).

In this case `teamcity.` prefix should be added.



```

# proxy specified only for Slack 

teamcity.slack.proxyHost=proxy.com

teamcity.slack.proxyPort=8888



# global JVM proxy

teamcity.http.proxyHost=proxy.com

teamcity.http.proxyPort=8888



# or

teamcity.https.proxyHost=proxy.com

teamcity.https.proxyPort=8888

```



In both ways the `proxyPort` property can be omitted and port `80` is used by default.



## Troubleshooting 



**Q:** I checked the option to send private messages and added the `{mention}` placeholder to the message, but neither the message was send to the slack user nor the name was mentioned in the slack message!



**A:** This plugin identifies the slack user by the email address of the committing user in the code repository. This requires that both accounts use the same email address.