https://github.com/Tapadoo/TCSlackNotifierPlugin

A hastily built plugin for TeamCity to post notifications to slack
https://github.com/Tapadoo/TCSlackNotifierPlugin

Last synced: 20 days ago
JSON representation

A hastily built plugin for TeamCity to post notifications to slack

• Host: GitHub
• URL: https://github.com/Tapadoo/TCSlackNotifierPlugin
• Owner: Tapadoo
• License: mit
• Created: 2014-02-28T17:21:04.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-05-08T10:02:00.000Z (about 1 year ago)
• Last Synced: 2024-03-26T12:57:28.717Z (3 months ago)
• Language: Java
• Size: 4.92 MB
• Stars: 80
• Watchers: 21
• Forks: 26
• Open Issues: 13
• Metadata Files:
  • Readme: README.markdown
  • Changelog: CHANGELOG.markdown
  • License: LICENSE.txt

Lists

• my-awesome-stars - Tapadoo/TCSlackNotifierPlugin - A hastily built plugin for TeamCity to post notifications to slack (Java)

README

        
# TCSlackNotifierPlugin - TeamCity -> Slack Notifications

A plugin for [TeamCity](http://www.jetbrains.com/teamcity/) to post notifications to [Slack](https://slack.com/)

It works by registering as a server listener, and posts to Slack on build events like successful builds (optionally also builds starting and failing)

# Build Plugin

Gradle is used to build. Wrapper is included in the project so you dont need to install it, just have java.

    ./gradlew buildZip

this will generate a zip file with the right meta data in the right folder structure at : `build/distributions/TCSlackNotifierPlugin-.zip` you can also download a build from GitHubs versions section. Make sure you download the binary zip and not the source.

# Install Plugin

In the latest version of teamcity, the plugin zip can be uploaded via the admin page. In older versions, deploy manually by copying the zip file into TeamCity plugin directory inside the data directory, usually `.BuildServer`

```

scp build/distributions/TCSlackNotifierPlugin-.zip buildserver:.BuildServer/plugins/

```

Then restart TeamCity.

# Configuration

### In Slack

Add a new webhook integration. Make a note of the URL.

### In TeamCity

Edit the main config file, usually `.BuildServer/config/main-config.xml` and add an element like so:

```

  ...

  

    #general

    https://hooks.slack.com/services/YYYYYY/XXXXXXX/ZZZZZZZZZZZZ

    http://build.tapadoo.com/img/icons/TeamCity32.png

  

  ...

  ...

```

You can set the attributes on slackNotifier element (postSuccessful,postFailed,postStarted) to decide that notifications you would like posted.

Set the `slackPostUrl` to point to the url provided on the Slack integration page for the incoming webhook you created. Change the logo url whatever you want or leave it out.

This by default will post all builds to Slack. You can tweak these on a project level though.

#### Project Config (Optional)

To change channel, change the Slack logo used for that project or disable per project:

Edit the plugin specific xml config, `plugin-settings.xml` probably somewhere inside `.BuildServer/config/projects/PROJECTNAME/pluginData`

```

  

    #blah

    http://host/somelogo.png

  

```

# Note on TeamCity version support

Version 3 was updated for TeamCity 2017.2 support. It was just a settings update and recompile - so any issues from previous versions remain.

Previous versions where built for TeamCity 7.1, but a few tests on the free version of TeamCity 8 went fine, and it seems to work there also. Users have reported it working on version 9 also.

### Issues

* All xml config - needs web ui extensions for updating settings from GUI. Considering it.

* Channel can be changed per-project either by environmental variable (SLACK_CHANNEL (env var may be broken)) or by changing the project specific xml in the data directory. This could also use web ui extension UI for editing.

* All or nothing notifications. By default, all builds are posted. It can be disabled per project, but not currently by build config.

# License

MIT License.