Release version 2.4.0

Author: jasonconnery

CHANGELOG.markdown

@@ -0,0 +1,15 @@
+#2.4.0
+
+* Added issues as attachment
+* Support for new Slack url format (droped splitting url & token that wasn't needed)
+
+#2.3.0
+
+* skipped - internal / test / scrapped version, not needed
+
+
+#2.2.0
+
+* added support for notifying build start and failute. disabled by default can be enabled in xml settings - see README
+
+

README.markdown

@@ -10,22 +10,22 @@ Gradle is used to build. Wrapper is included in the project so you dont need to
 
     ./gradlew buildZip
 
-this will generate a zip file with the right meta data in the right folder structure at : `build/distributions/TCSlackNotifierPlugin-<version>.zip`
+this will generate a zip file with the right meta data in the right folder structure at : `build/distributions/TCSlackNotifierPlugin-<version>.zip` you can also download a build from GitHubs versions section.
 
 #Install Plugin
 
 Copy the zip file into TeamCity plugin directory inside the data directory, usually `.BuildServer`
 
 ```
-scp build/distributions/TCSlackNotifierPlugin-<version>.zip buildserver:.BuildServer/plugins/slackNotifier.zip
+scp build/distributions/TCSlackNotifierPlugin-<version>.zip buildserver:.BuildServer/plugins/
 ```
 
 Then restart TeamCity.
 
 #Configuration
 
 ###In slack
-Add a new webhook integration. Make a note of the Token.
+Add a new webhook integration. Make a note of the URL.
 
 ###In TeamCity
 
@@ -35,9 +35,8 @@ Edit the main config file, usually `.BuildServer/config/main-config.xml` and add
 <server rootURL="http://localhost:8111">
   ...
   <slackNotifier postSuccessful="true" postFailed="false" postStarted="false" >
-    <slackWebToken>testToken2</slackWebToken>
     <slackDefaultChannel>#general</slackDefaultChannel>
-    <slackPostUrl>https://tapadoo.slack.com/services/hooks/incoming-webhook?token=</slackPostUrl>
+    <slackPostUrl>https://hooks.slack.com/services/YYYYYY/XXXXXXX/ZZZZZZZZZZZZ</slackPostUrl>
     <slackLogoUrl>http://build.tapadoo.com/img/icons/TeamCity32.png</slackLogoUrl>
   </slackNotifier>
   ...
@@ -46,31 +45,33 @@ Edit the main config file, usually `.BuildServer/config/main-config.xml` and add
 
 You can set the attributes on slackNotifier element (postSuccessful,postFailed,postStarted) to decide that notifications you would like posted.
 
-Replace the web token with the token from slack. Change the postUrl also to point to the right slack team. The url can be found in the webhook integraton page, just remove the token from the end. Change the logo url whatever you want.
+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 or disable per project:
+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`
+
 ```
 <settings>
   <slackSettings enabled="true">
     <channel>#blah</channel>
+    <logoUrl>http://host/somelogo.png</logoUrl>
   </slackSettings>
 </settings>
 ```
 
 #Note on TeamCity version support
 
-I'm still using **TeamCity 7.1** , but a few tests on the free version of TeamCity 8 went fine, and it seems to work there also.
+I'm still using **TeamCity 7.1** , but a few tests on the free version of TeamCity 8 went fine, and it seems to work there also. Have yet to test on TeamCity 9 but whats the chance it doesn't work?
 
 ###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) or by changing the project specific xml in the data directory. This could also use web ui extension UI for editing.
+* 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.
 
 

build.gradle

@@ -6,8 +6,8 @@ repositories {
 apply plugin: 'java'
 
 
-sourceCompatibility = 1.5
-version = '2.2.0'
+sourceCompatibility = 1.6
+version = '2.4.0'
 
 configurations {
     deploy

src/main/java/com/tapadoo/slacknotifier/SlackConfigProcessor.java

@@ -10,7 +10,6 @@
  */
 public class SlackConfigProcessor implements MainConfigProcessor {
 
-    public static final String PREF_KEY_SLACK_WEB_TOKEN = "slackWebToken";
     public static final String PREF_KEY_SLACK_DEF_CHANNEL = "slackDefaultChannel";
     public static final String PREF_KEY_SLACK_POSTURL = "slackPostUrl";
     public static final String PREF_KEY_SLACK_LOGOURL = "slackLogoUrl";
@@ -21,8 +20,6 @@ public class SlackConfigProcessor implements MainConfigProcessor {
     private static final java.lang.String ATTR_NAME_POST_STARTED = "postStarted" ;
     private static final java.lang.String ATTR_NAME_POST_FAILED = "postFailed" ;
 
-
-    private String token = "invalidToken";
     private String defaultChannel = "#general";
     private String postUrl;
     private String logoUrl;
@@ -56,14 +53,6 @@ public boolean postStarted()
         return postStarted ;
     }
 
-    public String getToken() {
-        return token;
-    }
-
-    public void setToken(String token) {
-        this.token = token;
-    }
-
     public String getDefaultChannel() {
         return defaultChannel;
     }
@@ -93,12 +82,10 @@ public void readFrom(org.jdom.Element element) {
 
         if( mainConfigElement == null )
         {
-            token = "" ;
-            postUrl = "http://localhost/?token=" ;
+            postUrl = "http://localhost/" ;
             return ;
         }
 
-        token = mainConfigElement.getChildText(PREF_KEY_SLACK_WEB_TOKEN);
         defaultChannel = mainConfigElement.getChildText(PREF_KEY_SLACK_DEF_CHANNEL);
         postUrl = mainConfigElement.getChildText(PREF_KEY_SLACK_POSTURL);
         logoUrl = mainConfigElement.getChildText(PREF_KEY_SLACK_LOGOURL);
@@ -145,15 +132,12 @@ public void readFrom(org.jdom.Element element) {
     public void writeTo(org.jdom.Element element) {
 
         Element mainConfigElement = new Element(PREF_CHILD_ELEMENT);
-        Element webTokenElement = new Element(PREF_KEY_SLACK_WEB_TOKEN);
         Element defChannelElement = new Element(PREF_KEY_SLACK_DEF_CHANNEL);
         Element postUrlElement = new Element(PREF_KEY_SLACK_POSTURL);
         Element logoUrlElement = new Element(PREF_KEY_SLACK_LOGOURL);
 
-        webTokenElement.setText(token);
         defChannelElement.setText(defaultChannel);
 
-        mainConfigElement.addContent(webTokenElement);
         mainConfigElement.addContent(defChannelElement);
         mainConfigElement.addContent(postUrlElement);
         mainConfigElement.addContent(logoUrlElement);

src/main/java/com/tapadoo/slacknotifier/SlackProjectSettings.java

@@ -10,8 +10,12 @@
  */
 public class SlackProjectSettings implements ProjectSettings {
 
+    public static final String ELEMENT_LOGO_URL = "logoUrl";
+    public static final String ATTR_ENABLED = "enabled";
+    public static final String ELEMENT_CHANNEL = "channel";
     private String projectId;
     private String channel;
+    private String logoUrl;
     private boolean enabled = true ;
 
     public SlackProjectSettings(String projectId) {
@@ -31,6 +35,14 @@ public void setChannel(String channel) {
         this.channel = channel;
     }
 
+    public String getLogoUrl() {
+        return logoUrl;
+    }
+
+    public void setLogoUrl(String logoUrl) {
+        this.logoUrl = logoUrl;
+    }
+
     public boolean isEnabled()
     {
         return this.enabled;
@@ -41,8 +53,9 @@ public void dispose() {
     }
 
     public void readFrom(Element element) {
-        Element channelElement = element.getChild("channel");
-        Attribute enabledAttr = element.getAttribute("enabled");
+        Element channelElement = element.getChild(ELEMENT_CHANNEL);
+        Element logoElement = element.getChild(ELEMENT_LOGO_URL);
+        Attribute enabledAttr = element.getAttribute(ATTR_ENABLED);
 
         if( enabledAttr != null )
         {
@@ -60,17 +73,26 @@ public void readFrom(Element element) {
         if( channelElement != null ) {
             this.channel = channelElement.getText();
         }
+
+        if( logoElement != null )
+        {
+            this.logoUrl = logoElement.getText();
+        }
     }
 
     public void writeTo(Element element) {
 
-        Element channelElement = new Element("channel");
+        Element channelElement = new Element(ELEMENT_CHANNEL);
         channelElement.setText(this.channel);
 
-        Attribute enabledAttr = new Attribute("enabled",Boolean.toString(enabled)) ;
+        Element logoUrlElement = new Element(ELEMENT_LOGO_URL);
+        logoUrlElement.setText(this.logoUrl);
+
+        Attribute enabledAttr = new Attribute(ATTR_ENABLED,Boolean.toString(enabled)) ;
         element.setAttribute( enabledAttr );
 
         element.addContent(channelElement);
+        element.addContent(logoUrlElement);
     }
 
 }