Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
cezarypiatek committed Nov 7, 2016
2 parents d7abe63 + 090fbf9 commit 36cc0f3
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,22 @@ Supported repositories:


##How to use it
###Prerequisites
1. CodeTopology is using svn.exe to generate svn log. It is a part of TortoiseSVN so you have to install TortoiseSVN with selected "command line client tools" option. This is required only for SVN repositories.

2. Script file dowloaded from the internet may be blocked. Before running script remember to unblock GenerateReport.ps1 file. In order to unblock script go to file options, find "Security" section on "General" tab and select "Unblock" option.

###Generate report
To generate CodeTopology report run the following script from powershell console

- For Git repository
```powershell
.\GenerateReport.ps1 -Verbose -VCS Git -CheckoutDir path_to_your_repository_checkout_dir
```

###Prerequisites
1. CodeTopology is using svn.exe to generate svn log. It is a part of TortoiseSVN so you have to install TortoiseSVN with selected "command line client tools" option.

2. Script file dowloaded from the internet may be locked. Before running script remember to unlock file in file's options.
- For SVN repository
```powershell
.\GenerateReport.ps1 -Verbose -VCS SVN -CheckoutDir path_to_your_repository_checkout_dir
```


##TeamCity integration
Expand Down
3 changes: 2 additions & 1 deletion src/GenerateReport.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ function Get-GitLog{

param($OutFilePath)
Write-Verbose "Start collecting Git log"
Add-Type -AssemblyName System.Web
$currentLocation = Get-Location
Set-Location $CheckoutDir
$logentrySeparator = [guid]::NewGuid()
Expand Down Expand Up @@ -195,4 +196,4 @@ switch($VCS)
}

Bundle-Report -ClocDataFile "$tmpDir\cloc.csv" -SvnLogFile "$tmpDir\svnlogfile.xml" -OutDataFile "$tmpDir\result.json"
Remove-Item $tmpDir -Recurse -Force
Remove-Item $tmpDir -Recurse -Force

0 comments on commit 36cc0f3

Please sign in to comment.