Aug 3, 2009

A Release Notes Report for TFS

One of the things people often ask me when talking about Team Foundation Server is how they can easily get a Release Notes report from it. Unfortunately there isn’t anything out of the box that does it and various searches on the net haven’t returned anything useful.

So this report idea has been on my backlog of things to do for a while and Aaron prompted me about it the other day and even provided me a bit of SQL to help push me along :-)

Anyway here’s what the report looks like:

image

Nothing too fancy – it just prompts you for the date and then a path from which to pick up changes.

“Why the path?” I hear you ask. Well, if you’re like most people you will have a source tree that is configured for branching your code and I assume you don’t really want a release notes report that shows changes in the other branches :-). The report is set to only pick up changes made to files at or below the path specified so that you have a way to only report on changes relevant to you.

Installation

Installation is pretty simple:

  1. Upload the report to SSRS
  2. Change the Shared DataSource to point to your TFSReportDS
  3. Change the ExplicitReport parameter to not prompt for user input (as shown)
  4. View the report

image

If you have any problems with the report feel free to drop me a line or leave a comment.

Feel free to take this report and customise and improve it as much as you like. Of course I’d appreciate updates and patches for any bugs you find or improvements you make to it.

The SQL in the report itself is somewhat ugly as I had to work around some limitations in what is stored in the TFS data warehouse and some other strange behaviours, but it at least works.

I hope it helps!

Note: The report was built and tested against TFS2008 running on a SQL2005 database so it should be OK for both SQL2005 and SQL2008 users.

Download the report definition here

9 comments:

  1. I tried to upload the rdl file to my SSRS for TFS but hit with an hexadecimal value 0x0B, is an invalid character.

    ReplyDelete
  2. Hmm. I wonder if you have a different collation sequence or something that is throwing it off? Can you open the rdl in Visual Studio?

    ReplyDelete
  3. I'm getting the same error as Zech.

    ReplyDelete
  4. Hmm. I'd say your locale is difference to mine (not surprising).

    Have a look for this line:
    set @backslashpath = REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(@path,'/','\'),'-','"'),'%','|'),'_','>'),'''',' '

    For the moment just remove that last substituion (it's a vertical tab) and see if things work.

    ReplyDelete
  5. Hi,
    Is this plugin supposted to work for TFS2010 as well? I tried to install it on TFS2010, but get an error stating: "An error has occurred during report processing. (rsProcessingAborted)
    Query execution failed for dataset 'FilePaths'. (rsErrorExecutingCommand) Invalid object name 'file'."
    Any idea how to fix this?

    ReplyDelete
  6. It would be nice if this worked for TFS 2010

    ReplyDelete
  7. Hi, I cannot seem to download the report definition file, i get routed to google groups saying that the download link is incorrect.

    ReplyDelete
  8. Please assist with getting the rdl file.

    ReplyDelete
  9. Hi Deon, I've lost the rdl in the years since this post was written and Google has dropped the location where I had it hosted :-(

    I'll update the post to indicate this.

    ReplyDelete