This plugin provides GitHub integration for TeamCity 7.1 and later releases, automatically reporting the status of a TeamCity build to its corresponding GitHub repository.
Please note that TeamCity 10.0 and later releases now include built-in support for updating GitHub and other platforms through the bundled Commit Status Publisher, which effectively replaces this TeamCity.GitHub project. No further work is being done on TeamCity.GitHub, and we recommend that users migrate to Commit Status Publisher.
About the Plugin
The purpose of creating this plugin is to support integration with the GitHub Change Status API in TeamCity, which allows TeamCity to automatically attach build statuses to GitHub pull requests.
The plugin is described in more detail in the following blog posts:
Other useful links:
- GitHub Pull Requests plugin for TeamCity | TeamCity Blog
- Commit Status Publisher - TeamCity - Confluence
Installation and Configuration
NOTE Ensure that your download of the
.zip file is valid - you may be redirected to the login page when using
Next, put the downloaded
.zip file into the
<TeamCity Data Directory>/plugins folder and restart the TeamCity server. You can also upload the .zip directly by clicking "Upload plugin zip" in the Plugins List section of the Administration settings in TeamCity's web interface.
After restarting the server, the plugin should show up as an external plugin in the Plugins List section of the Administration settings.
To use the plugin with one of your TeamCity projects, ensure that your VCS root branch specification includes pull requests:
+:refs/pull/(*/head) (build number will include
+:refs/pull/(*)/head (build number will not include
Note: It is also possible to use
+:refs/pull/(*/merge), but not recommended. There is some risk that this spec will cause a feedback loop of builds that will bog down your TeamCity server. See this bug report for more information.
Finally, add a new Build Feature to your project's configuration. Choose "Report change status to GitHub" from the list, fill in the necessary info in the dialog, and you should be good to go!
We maintain two branches,
stable. Development is done in
The plugin from the
stable branch is expected to be more stable and feature-lacking.
It is highly recommended to use builds from the
Try the build from
master first. If you see problems, please report them as issues first.
If an urgent fix is required, then try a build from the
This is the list of TeamCity Internal Properites that are supported by the plugin.
teamcity.github.verify.ssl.certificate=true|false enable/disable https certificates check. default is false
teamcity.github.http.timeout GitHub connection timeout in milliseconds, default 5 minutes
Properties to configure Proxy server settings used for GitHub conncetions.
teamcity.github.http.proxy.port defines proxy host/port
teamcity.github.http.proxy.password optionally defines proxy credentials
teamcity.github.http.proxy.workstation optionally deifnes NT doamin credentials
Current Status: Deprecated
TeamCity.GitHub implements a simple approach to updating change status to github. Only username/password authentication is supported. No further work is being done on TeamCity.GitHub, and users are advised to migrate to Commit Status Publisher.
This is my Eugene Petrenko private home project