Skip to content

Commit fe02b32

Browse files
authored
Update README
"Slack" should start with uppercase. Fix headings.
1 parent d50f013 commit fe02b32

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

README.markdown

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# TCSlackNotifierPlugin - TeamCity -> Slack Notifications
22

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

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

7-
#Build Plugin
7+
# Build Plugin
88

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

1111
./gradlew buildZip
1212

1313
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.
1414

15-
#Install Plugin
15+
# Install Plugin
1616

1717
Copy the zip file into TeamCity plugin directory inside the data directory, usually `.BuildServer`
1818

@@ -22,12 +22,12 @@ scp build/distributions/TCSlackNotifierPlugin-<version>.zip buildserver:.BuildSe
2222

2323
Then restart TeamCity.
2424

25-
#Configuration
25+
# Configuration
2626

27-
###In slack
27+
### In Slack
2828
Add a new webhook integration. Make a note of the URL.
2929

30-
###In TeamCity
30+
### In TeamCity
3131

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

@@ -45,13 +45,13 @@ Edit the main config file, usually `.BuildServer/config/main-config.xml` and add
4545

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

48-
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.
48+
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.
4949

50-
This by default will post all builds to slack. you can tweak these on a project level though
50+
This by default will post all builds to Slack. You can tweak these on a project level though.
5151

52-
####Project Config (Optional)
52+
#### Project Config (Optional)
5353

54-
To change channel, change the slack logo used for that project or disable per project:
54+
To change channel, change the Slack logo used for that project or disable per project:
5555

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

@@ -64,17 +64,17 @@ Edit the plugin specific xml config, `plugin-settings.xml` probably somewhere in
6464
</settings>
6565
```
6666

67-
#Note on TeamCity version support
67+
# Note on TeamCity version support
6868

6969
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. Users have reported it working on version 9 also.
7070

71-
###Issues
71+
### Issues
7272

73-
* all xml config - needs web ui extensions for updating settings from GUI. Considering it.
74-
* 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.
73+
* All xml config - needs web ui extensions for updating settings from GUI. Considering it.
74+
* 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.
7575
* All or nothing notifications. By default, all builds are posted. It can be disabled per project, but not currently by build config.
7676

7777

7878
# License
7979

80-
MIT License.
80+
MIT License.

0 commit comments

Comments
 (0)