Skip to content

Commit

Permalink
- Updated module metadata to point to GitHub site.
Browse files Browse the repository at this point in the history
- Updated readme.md a bit.
  • Loading branch information
deadlydog committed May 25, 2016
1 parent 54e1dc4 commit 106a59c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 13 deletions.
4 changes: 2 additions & 2 deletions Invoke-MsBuild/Invoke-MsBuild.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,10 @@ PrivateData = @{
Tags = @('Invoke', 'MsBuild', 'Invoke-MsBuild', 'Build', 'Compile')

# A URL to the license for this module.
LicenseUri = 'https://invokemsbuild.codeplex.com/license'
LicenseUri = 'https://github.com/deadlydog/Invoke-MsBuild/blob/master/license.md'

# A URL to the main website for this project.
ProjectUri = 'https://invokemsbuild.codeplex.com'
ProjectUri = 'https://github.com/deadlydog/Invoke-MsBuild'

# A URL to an icon representing this module.
# IconUri = ''
Expand Down
31 changes: 20 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ Invoke-MsBuild -Path "C:\Some Folder\MySolution.sln"

# Examples

### EXAMPLE
```
$buildResult = Invoke-MsBuild -Path "C:\Some Folder\MySolution.sln"
Expand All @@ -34,7 +33,8 @@ else if ($buildResult.BuildSucceeded -eq $null)
Perform the default MsBuild actions on the Visual Studio solution to build the projects in it, and returns a hash table containing the results.
The PowerShell script will halt execution until MsBuild completes.

### EXAMPLE
---

```
$process = Invoke-MsBuild -Path "C:\Some Folder\MySolution.sln" -PassThru
Expand All @@ -49,7 +49,8 @@ Perform the default MsBuild actions on the Visual Studio solution to build the p
The PowerShell script will not halt execution; instead it will return the process running MsBuild.exe back to the caller while the build is performed.
You can check the process's HasExited property to check if the build has completed yet or not.

### EXAMPLE
---

```
if ((Invoke-MsBuild -Path $pathToSolution).BuildSucceeded -eq $true)
{
Expand All @@ -58,23 +59,26 @@ if ((Invoke-MsBuild -Path $pathToSolution).BuildSucceeded -eq $true)
```
Perfom the build against the file specified at $pathToSolution and checks it for success in a single line.

### EXAMPLE
---

```
Invoke-MsBuild -Path "C:\Some Folder\MyProject.csproj" -MsBuildParameters "/target:Clean;Build" -ShowBuildOutputInNewWindow
```

Cleans then Builds the given C# project.
A window displaying the output from MsBuild will be shown so the user can view the progress of the build.

### EXAMPLE
---

```
Invoke-MsBuild -Path "C:\MySolution.sln" -Params "/target:Clean;Build /property:Configuration=Release;Platform=x64;BuildInParallel=true /verbosity:Detailed /maxcpucount"
```

Cleans then Builds the given solution, specifying to build the project in parallel in the Release configuration for the x64 platform.
Here the shorter "Params" alias is used instead of the full "MsBuildParameters" parameter name.

### EXAMPLE
---

```
Invoke-MsBuild -Path "C:\Some Folder\MyProject.csproj" -ShowBuildOutputInNewWindow -PromptForInputBeforeClosing -AutoLaunchBuildLogOnFailure
```
Expand All @@ -84,7 +88,8 @@ A window displaying the output from MsBuild will be shown so the user can view t
gives the window some input after the build completes. This function will also not return until the user gives the window some input, halting the powershell script execution.
If the build fails, the build log will automatically be opened in the default text viewer.

### EXAMPLE
---

```
Invoke-MsBuild -Path "C:\Some Folder\MyProject.csproj" -BuildLogDirectoryPath "C:\BuildLogs" -KeepBuildLogOnSuccessfulBuilds -AutoLaunchBuildErrorsLogOnFailure
```
Expand All @@ -93,15 +98,17 @@ Builds the given C# project.
The build log will be saved in "C:\BuildLogs", and they will not be automatically deleted even if the build succeeds.
If the build fails, the build errors log will automatically be opened in the default text viewer.

### EXAMPLE
---

```
Invoke-MsBuild -Path "C:\Some Folder\MyProject.csproj" -BuildLogDirectoryPath PathDirectory
```

Builds the given C# project.
The keyword 'PathDirectory' is used, so the build log will be saved in "C:\Some Folder\", which is the same directory as the project being built (i.e. directory specified in the Path).

### EXAMPLE
---

```
Invoke-MsBuild -Path "C:\Database\Database.dbproj" -P "/t:Deploy /p:TargetDatabase=MyDatabase /p:TargetConnectionString=`"Data Source=DatabaseServerName`;Integrated Security=True`;Pooling=False`" /p:DeployToDatabase=True"
```
Expand All @@ -110,7 +117,8 @@ Deploy the Visual Studio Database Project to the database "MyDatabase".
Here the shorter "P" alias is used instead of the full "MsBuildParameters" parameter name.
The shorter alias' of the MsBuild parameters are also used; "/t" instead of "/target", and "/p" instead of "/property".

### EXAMPLE
---

```
Invoke-MsBuild -Path "C:\Some Folder\MyProject.csproj" -WhatIf
```
Expand All @@ -119,7 +127,8 @@ Returns the result object containing the same property values that would be crea
The BuildSucceeded property will be $null since no build will actually be invoked.
This will display all of the returned object's properties and their values.

### EXAMPLE
---

```
Invoke-MsBuild -Path "C:\Some Folder\MyProject.csproj" > $null
```
Expand Down

0 comments on commit 106a59c

Please sign in to comment.