Teamcity-Phabricator-Plugin/README.md

# Splint
_X-Lab's Linting Spine_

## Things
This repository holds the plugins created to link together our internal systems. The original premise to link Phabricator, TeamCity and SonarQube to enable linting on differential reviews.

Below are the plugins:
* Harbormaster-Teamcity-Plugin
* Teamcity-Phabricator-Plugin
* SonarQube-Phabricator-Plugin

### Harbomaster-Teamcity-Plugin

The harbormaster plugin allows us to trigger a build configuration within TeamCity as part of a harbormaster build plan.

The plugin requires:
1. TeamCity URI
2. Build Configuration to trigger a build for
3. TeamCity access token to authenticate with the server

To deploy simply drag the contents of the folder to `src/extensions/` on the Phabricator instance and then restart the application.

### Teamcity-Phabricator-Plugin

The teamcity plugin comprises of server and agent plugins for teamcity. 

#### Server
The server plugin monitors builds with the phabricator feature enabled waiting for builds to finish and notify phabricator.

Once build is triggered from phabricator using **Harbomaster-Teamcity-Plugin** and the phabricator build feature is configured on the build configuration then the server plugin will wait and listen for the build to finish before reporting the result back to harbormaster to be displayed in phabricator.

## Getting Started

**Harbormaster-Teamcity-Plugin**
No building is needed for for the harbormaster plugin just dev away and copy the files into the `src/extensions` folder with your phabricator instance

**Teamcity-Phabricator-Plugin**

You will need to move in to the `Teamcity-Phabricator-Plugin/` folder:

* To build the plugins (server and agent) just run: `mvn package`

By default the teamcity plugin is equipped with teamcity-sdk-maven-plugin which allows for a local instance of teamcity with debugging capabilities. See their documentation for how to use: https://github.com/JetBrains/teamcity-sdk-maven-plugin

## Useful Links

* https://confluence.jetbrains.com/display/TCD10/Web+UI+Extensions
* http://javadoc.jetbrains.net/teamcity/openapi/current/jetbrains/buildServer/serverSide/BuildServerAdapter.html
* https://github.com/JetBrains/teamcity-sdk-maven-plugin/wiki/Developing-TeamCity-plugin
* https://www.quali.com/blog/teamcity-plugin-development-journey/
* https://plugins.jetbrains.com/docs/teamcity/plugin-development-faq.html
* https://plugins.jetbrains.com/docs/teamcity/getting-started-with-plugin-development.html
Initial Commit 2019-05-30 14:08:17 +02:00			`# Splint`
			`_X-Lab's Linting Spine_`

			`## Things`
			`This repository holds the plugins created to link together our internal systems. The original premise to link Phabricator, TeamCity and SonarQube to enable linting on differential reviews.`

			`Below are the plugins:`
Add Harbormaster TeamCity Plugin The complete plugin required to trigger a teamcity build from a harbormaster build plan. 2019-05-30 14:16:13 +02:00			`* Harbormaster-Teamcity-Plugin`
			`* Teamcity-Phabricator-Plugin`
			`* SonarQube-Phabricator-Plugin`

			`### Harbomaster-Teamcity-Plugin`

			`The harbormaster plugin allows us to trigger a build configuration within TeamCity as part of a harbormaster build plan.`

			`The plugin requires:`
			`1. TeamCity URI`
			`2. Build Configuration to trigger a build for`
			`3. TeamCity access token to authenticate with the server`

			To deploy simply drag the contents of the folder to `src/extensions/` on the Phabricator instance and then restart the application.
Initial Commit 2019-05-30 14:08:17 +02:00
Add Basic TeamCity Phabricator Plugin Using TeamCity plugin template create an empty client and server plugin which will report back to phabricator 2019-05-30 14:53:15 +02:00			`### Teamcity-Phabricator-Plugin`

			`The teamcity plugin comprises of server and agent plugins for teamcity.`

			`#### Server`
			`The server plugin monitors builds with the phabricator feature enabled waiting for builds to finish and notify phabricator.`

Send Build Result to Harbormaster Once a build with the phabricator build feature configured is completed then the build status will be sent back to harbormaster. 2019-06-03 12:21:53 +02:00			`Once build is triggered from phabricator using Harbomaster-Teamcity-Plugin and the phabricator build feature is configured on the build configuration then the server plugin will wait and listen for the build to finish before reporting the result back to harbormaster to be displayed in phabricator.`

			`## Getting Started`

			`Harbormaster-Teamcity-Plugin`
			No building is needed for for the harbormaster plugin just dev away and copy the files into the `src/extensions` folder with your phabricator instance

			`Teamcity-Phabricator-Plugin`

			You will need to move in to the `Teamcity-Phabricator-Plugin/` folder:

			* To build the plugins (server and agent) just run: `mvn package`

			`By default the teamcity plugin is equipped with teamcity-sdk-maven-plugin which allows for a local instance of teamcity with debugging capabilities. See their documentation for how to use: https://github.com/JetBrains/teamcity-sdk-maven-plugin`

Initial Commit 2019-05-30 14:08:17 +02:00			`## Useful Links`

			`* https://confluence.jetbrains.com/display/TCD10/Web+UI+Extensions`
			`* http://javadoc.jetbrains.net/teamcity/openapi/current/jetbrains/buildServer/serverSide/BuildServerAdapter.html`
			`* https://github.com/JetBrains/teamcity-sdk-maven-plugin/wiki/Developing-TeamCity-plugin`
			`* https://www.quali.com/blog/teamcity-plugin-development-journey/`
			`* https://plugins.jetbrains.com/docs/teamcity/plugin-development-faq.html`
			`* https://plugins.jetbrains.com/docs/teamcity/getting-started-with-plugin-development.html`