QuickBuild2 Documentation
|
QuickBuild now integrate with Trac natively. The integration features:
This page will describe how to integrate Trac in QuickBuild. On This Page
Basic IntegrationTo enable the integration:
After doing these, the issues keys mentioned in commit messages will be hyperlinked: and a ticket report will be displayed in Build tab: you can also find all related issues from a specified version and view the changes for an issue: After configured the Trac server in the configuration settings, below steps are available to add in your build workflow:
Advanced IntegrationBesides the basic integration, QuickBuild also features:
Update TicketsTo update tickets from the commit messages, Update Trac Ticket step should be added to your build workflow. And when QuickBuild find any commit commands in the commit messages, QuickBuild will submit them to Trac to update or progress the tickets. NOTE:
Associated SCM user with Trac userIf the username and password in your SCM, QuickBuild and Trac are same, the association between them is already set up. Or you have to associate them together:
Customize Commit CommandThe commit command can be customized in step definition: The commit command property defines the commit command which you can change to meet your company requirements. And the update attributes here are what you want to change in your Trac when executing the commit command. For example, when executing accept commit command above, QuickBuild will update the ticket status and change it to accept, also will update the owner to the command committer which is same as the SCM committer. Below section will discuss the attributes available. Command AttributesThe command attributes for Trac are defined by the Trac server. You may ask your Trac administrator for available attributes or reference http://trac.edgewall.org/wiki/TracTickets. By default Trac installation, the attributes include:
These attributes can be used not only in the Update Trac Ticket step, but also in the commit commands. Besides the attributes specified in the commit command, the Extra Attributes in the step definition is used to add some common attributes you want. For example, you want leave a comment against each updating, you may define the extra attributes like: comment = Updated in build ${build.getVersion} Each attribute should use one line and you can use script (see the example above) which gives you more flexibility to control the value you want to input to the issue. Release MilestoneTo release milestone to Trac server, Release Trac Milestone step should be added to your build workflow. This step will set or update the complete date of milestone, if the milestone does not exist in Trac, QuickBuild will create it and add it to Trac. This step will also update the milestone field of all tickets mentioned in the commit messages from previous successful build. Although, the released milestone uses build version, you can still manage the milestone by yourself from Trac side and let QuickBuild use them. Use Trac milestone as build versionTo use Trac milestone as your build version is very simple, you just need go to configuration settings and set the property Next Build Version to Use next unreleased milestone from Trac. By doing this, the next build version will use the default next milestone which defined in Trac. Create TicketBy adding Create Trac Ticket step, you can create a ticket to Trac based on your step condition which can be used to manage the build status in the Trac. |