This is an Open Source Project done by the students of Boston University.Releasing software with a Continuous Integration (CI) Pipeline can greatly increase the speed with which code gets released.This is great for developers to determine the source of a bug in a particular build, but the source control does not hold much value when it comes to communicating the business content of the build. When a build gets deployed, the business wants to know what the content of the build is, so that they are clear about what to test, as well as what can be released to production. This often means a manual step in the CI process is necessary: the developer must look up the work items in the work item tracking software, and enter them manually into the release tracking software. The goal of this project is to eliminate that manual step of entering release notes by integrating the build pipeline with Work Item Tracking software.
Plugin is an efficient tool to eliminate the manual step of entering release notes by integrating the build pipeline(Teamcity) with work item tracking software(Visual Studio). This plugin is able to parse commit messages from Source Control for work items and get data from Work Item Tracking Software(VSTS) to output the work item information to a text file in a default or customized format.
- Plugin is tested to work with TeamCity 9.1.x
- Agent and server are expected to run JRE 1.7
- Download the plugin build (binaries) from https://github.com/BU-NU-CLOUD-SP16/Automated-Release-Notes/releases/download/ARN1.0.1/ARNPlugin.zip
- Make sure downloaded .zip file is not corrupted
- Put the downloaded plugin .zip file into /plugins folder
- Restart the TeamCity Server
- Open Administration | Plugins and check you see the plugin listed
For more details, there is documentation
- Download project files from the download zip button of this repository,you will have a downloaded file: Automated-Release-Notes-master.zip .
- Or use git clone:
git clone https://github.com/BU-NU-CLOUD-SP16/Automated-Release-Notes- Extract the zip file and open the project in IntelliJ IDEA.
- Add TeamCity distribution path variable, with Name:TeamCityDistribution and Path:Teamcity home directory.
- To build the plugin build plugin-zip which you will find here : Build -> Build Artifacts -> plugin-zip
- Once plugin-zip artifact is built, you will have a zip file generated in the folder where you extracted the Automated-Release-Notes-master.zip in Automated-Release-Notes-master\out\artifacts\plugin_zip .
- Upload the ARNPlugin.zip file in Teamcity as a plugin, logout and restart Teamcity server. For more details regarding installing the plugin, there is teamcity documentation
- Once Teamcity server is restarted,go to the Build Steps of the Build Configuration for which you want to add the Automated Release Notes runner and add a build step.
- Choose "Automated Release Notes" runner as your 'Runner Type', which is an ANT type runner.
- For 'Output File Path' specify a folder name where you want the release notes to be generated.The output file(s) will be generated relative to the checkout directory.
- Provide appropriate VSTS url,username and password.
- Select the release notes file format ie. doc, pdf or text type.
- Enter format string template which specifies the format of text in your output file(s), for more information on format string click on the button 'information about format string', disable ad blocker or pop-up blocker if the button doesn't function. The Format String textbox already has a default format string which can be customized as per your needs. If the format string is empty the output file(s) will be generated using a default format string.
- Save the build step configuration and run the build.
The build step configuration should look like this:
- TeamCity server and agent plugin bundle.
- Pre-configured IDEA settings to support references to TeamCity
- Uses
$TeamCityDistribution$ IDEA path variable as path to TeamCity home (unpacked .tar.gz or .exe distribution) - Bunch of libraries for most recent needed TeamCity APIs