Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JayJian committed Apr 25, 2016
1 parent 3633a48 commit 0e5b1f1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Automated-Release-Notes
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 know 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.
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.

# Features
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.
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.

# Supported Versions

Expand Down Expand Up @@ -35,7 +35,7 @@ git clone https://github.com/BU-NU-CLOUD-SP16/Automated-Release-Notes
* 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](https://confluence.jetbrains.com/display/TCD9/Build+Checkout+Directory).
* Provide appropriate VSTS url,username and password.
* Select the release notes file format ie. doc,pdf or text type.
* 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:
Expand Down

0 comments on commit 0e5b1f1

Please sign in to comment.