Skip to content

Commit 3804046

Browse files
committed
Updating documentation
1 parent e504857 commit 3804046

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

ReadMe.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Setting the MinimumRequiredVersion property forces the ClickOnce application to
77
# Script Parameters
88
* **ProjectFilePath** (required) - Path of the .csproj and .vbproj file to process.
99

10-
* **Version** - The Version to update the ClickOnce version number to. This version must be of the format Major.Minor.Build or Major.Minor.Build.Revision. The Build and Revision parts will be overridden by the BuildSystemsBuildId and IncrementProjectFilesRevision parameters, if they are provided.
10+
* **Version** - The Version to update the ClickOnce version number to. This version must be of the format Major.Minor.Build or Major.Minor.Build.Revision. The Build and Revision parts will be overridden by the BuildSystemsBuildId parameter, if it is provided. The Revision parts will be overriden by the IncrementProjectFilesRevision parameter, if it is provided.
1111

1212
* **BuildSystemsBuildId** - The build system's unique and auto-incrementing Build ID. This will be used to generate the Build and Revision parts of the new Version number. This will override the Build and Revision specified in the Version parameter, if it was provided. This parameter cannot be used with the IncrementProjectFilesRevision parameter.
1313

@@ -17,14 +17,14 @@ Setting the MinimumRequiredVersion property forces the ClickOnce application to
1717

1818

1919
# Examples
20-
Update a project file's ClickOnce version.
20+
Update a project file's ClickOnce version to the specified version.
2121
```
2222
& .\Set-ProjectFilesClickOnceVersion.ps1 -ProjectFilePath "C:\SomeProject.csproj" -Version '1.2.3.4'
2323
```
2424

2525
---
2626

27-
Update just the Build and Revision parts of a project file's ClickOnce version.
27+
Update the Build and Revision parts of a project file's ClickOnce version, based on a unique, auto-incrementing integer, such as a build system's Build ID.
2828
```
2929
& .\Set-ProjectFilesClickOnceVersion.ps1 -ProjectFilePath "C:\SomeProject.csproj" -BuildSystemsBuildId 123456
3030
```

Set-ProjectFilesClickOnceVersion.ps1

+4-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
1313
.PARAMETER Version
1414
The Version to update the ClickOnce version number to. This version must be of the format Major.Minor.Build or Major.Minor.Build.Revision.
15-
The Build and Revision parts will be overridden by the BuildSystemsBuildId and IncrementProjectFilesRevision parameters, if they are provided.
15+
The Build and Revision parts will be overridden by the BuildSystemsBuildId parameter, if it is provided.
16+
The Revision parts will be overriden by the IncrementProjectFilesRevision parameter, if it is provided.
1617
1718
.PARAMETER BuildSystemsBuildId
1819
The build system's unique and auto-incrementing Build ID. This will be used to generate the Build and Revision parts of the new Version number.
@@ -28,12 +29,12 @@
2829
Setting the MinimumRequiredVersion property forces the ClickOnce application to update automatically without prompting the user.
2930
3031
.EXAMPLE
31-
Update a project file's ClickOnce version.
32+
Update a project file's ClickOnce version to the specified version.
3233
3334
& .\Set-ProjectFilesClickOnceVersion.ps1 -ProjectFilePath "C:\SomeProject.csproj" -Version '1.2.3.4'
3435
3536
.EXAMPLE
36-
Update just the Build and Revision parts of a project file's ClickOnce version.
37+
Update the Build and Revision parts of a project file's ClickOnce version, based on a unique, auto-incrementing integer, such as a build system's Build ID.
3738
3839
& .\Set-ProjectFilesClickOnceVersion.ps1 -ProjectFilePath "C:\SomeProject.csproj" -BuildSystemsBuildId 123456
3940

0 commit comments

Comments
 (0)