Skip to content

Commit d42faf2

Browse files
justin-pjustin-p
committed
Capitalize all README.md files. Move buildreports folder to build\reports\$ModuleVersion\.
1 parent 610abf0 commit d42faf2

25 files changed

Lines changed: 63 additions & 63 deletions

‎ModuleBuild.build.ps1‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,8 @@ task VersionCheck LoadModuleManifest, {
120120

121121
#Synopsis: Create a CodeHealthReport of your existing code
122122
task CodeHealthReport -if {$Script:BuildEnv.OptionCodeHealthReport} ValidateRequirements, LoadRequiredModules, {
123-
$BuildReportsFolder = Join-Path $BuildRoot $Script:BuildEnv.BuildReportsFolder
124-
Write-Description White "Creating a prebuild code health report of your public functions to $($Script:BuildEnv.BuildReportsFolder)" -accent
123+
$BuildReportsFolder = Join-Path $BuildRoot $(Join-Path $Script:BuildEnv.BuildReportsFolder $Script:BuildEnv.ModuleVersion)
124+
Write-Description White "Creating a prebuild code health report of your public functions to $($BuildReportsFolder)" -accent
125125

126126
if (-not (Test-Path $BuildReportsFolder)) {
127127
[void](New-Item -Path $BuildReportsFolder -ItemType:Directory)

‎build/ModuleBuild.buildenvironment.ps1‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,15 @@ if ((Get-Variable 'BuildEnv' -ErrorAction:SilentlyContinue) -eq $null) {
5151
# Generate a yml file in the root folder of this project for readthedocs.org integration
5252
OptionGenerateReadTheDocs = $True
5353
# Most of the following options you probably don't need to change
54-
BaseSourceFolder = 'src' # Base source path
55-
PublicFunctionSource = "src\public" # Public functions (to be exported by file name as the function name)
56-
PrivateFunctionSource = "src\private" # Private function source
57-
OtherModuleSource = "src\other" # Other module source
58-
BaseReleaseFolder = 'release' # Releases directory.
59-
BuildReportsFolder = 'buildreports'
60-
BuildToolFolder = 'build' # Build tool path (these scripts are dot sourced)
61-
ScratchFolder = 'temp' # Scratch path - this is where all our scratch work occurs. It will be cleared out at every run.
62-
FunctionTemplates = "src\templates" # Location of function template files (*.tem)
54+
BaseSourceFolder = 'src' # Base source path
55+
PublicFunctionSource = "src\public" # Public functions (to be exported by file name as the function name)
56+
PrivateFunctionSource = "src\private" # Private function source.
57+
OtherModuleSource = "src\other" # Other module source.
58+
BaseReleaseFolder = 'release' # Releases directory.
59+
BuildToolFolder = 'build' # Build tool path.
60+
BuildReportsFolder = 'build\reports' # Location where PSCodeHealth stores its reports.
61+
ScratchFolder = 'temp' # Scratch path - this is where all our scratch work occurs. It will be cleared out at every run.
62+
FunctionTemplates = "src\templates" # Location of function template files (*.tem)
6363

6464
# If you will be publishing to the PowerShell Gallery you will need a Nuget API key (can get from the website)
6565
# You should not actually enter this key here but should manually enter it in the ModuleBuild.buildenvironment.json file

buildreports/CodeHealthReport-Private.html renamed to build/reports/0.2.4/CodeHealthReport-Private.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ <h1>
189189
<div class="col-sm-4 col-md-5 col-lg-4 right-header">
190190
<h5>
191191
Analyzed path :<span class="right-header-data"> src\private</span><br>
192-
Analysis date :<span class="right-header-data"> 2019-12-18 12:36:29Z</span>
192+
Analysis date :<span class="right-header-data"> 2019-12-18 13:47:45Z</span>
193193
</h5>
194194
</div>
195195
</div>

buildreports/CodeHealthReport-Public.html renamed to build/reports/0.2.4/CodeHealthReport-Public.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ <h1>
189189
<div class="col-sm-4 col-md-5 col-lg-4 right-header">
190190
<h5>
191191
Analyzed path :<span class="right-header-data"> src\public</span><br>
192-
Analysis date :<span class="right-header-data"> 2019-12-18 12:35:22Z</span>
192+
Analysis date :<span class="right-header-data"> 2019-12-18 13:46:37Z</span>
193193
</h5>
194194
</div>
195195
</div>

‎plaster/ModuleBuild/plasterManifest.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
templateType="Project" xmlns="http://www.microsoft.com/schemas/PowerShell/Plaster/v1">
55
<metadata>
66
<name>ModuleBuild</name>
7-
<id>55b08727-3388-410c-98af-8221e5b73f0f</id>
7+
<id>24893028-d92f-41ac-ac2b-f22b1fb816dc</id>
88
<version>0.0.1</version>
99
<title>New ModuleBuild Project</title>
1010
<description>Create a new PowerShell Module with a ModuleBuild wrapper</description>
@@ -263,8 +263,8 @@
263263
source="scaffold\build\modulename.buildenvironment.template"
264264
destination="build\${PLASTER_PARAM_ModuleName}.buildenvironment.ps1" />
265265
<templateFile
266-
source="scaffold\readme.md"
267-
destination="Readme.md" />
266+
source="scaffold\README.md"
267+
destination="README.md" />
268268
<templateFile
269269
source="scaffold\Build.template"
270270
destination="Build.ps1" />

‎plaster/ModuleBuild/scaffold/build/modulename.buildenvironment.template‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,15 @@ if ((Get-Variable 'BuildEnv' -ErrorAction:SilentlyContinue) -eq $null) {
5050
# Generate a yml file in the root folder of this project for readthedocs.org integration
5151
OptionGenerateReadTheDocs = $<%=$PLASTER_PARAM_OptionGenerateReadTheDocs%>
5252
# Most of the following options you probably don't need to change
53-
BaseSourceFolder = 'src' # Base source path
54-
PublicFunctionSource = "src\public" # Public functions (to be exported by file name as the function name)
55-
PrivateFunctionSource = "src\private" # Private function source
56-
OtherModuleSource = "src\other" # Other module source
57-
BaseReleaseFolder = 'release' # Releases directory.
58-
BuildReportsFolder = 'buildreports' # Reports from the build process
59-
BuildToolFolder = 'build' # Build tool path (these scripts are dot sourced)
60-
ScratchFolder = 'temp' # Scratch path - this is where all our scratch work occurs. It will be cleared out at every run.
61-
FunctionTemplates = "src\templates" # Location of function template files (*.tem)
53+
BaseSourceFolder = 'src' # Base source path
54+
PublicFunctionSource = "src\public" # Public functions (to be exported by file name as the function name)
55+
PrivateFunctionSource = "src\private" # Private function source.
56+
OtherModuleSource = "src\other" # Other module source.
57+
BaseReleaseFolder = 'release' # Releases directory.
58+
BuildToolFolder = 'build' # Build tool path.
59+
BuildReportsFolder = 'build\reports' # Location where PSCodeHealth stores its reports.
60+
ScratchFolder = 'temp' # Scratch path - this is where all our scratch work occurs. It will be cleared out at every run.
61+
FunctionTemplates = "src\templates" # Location of function template files (*.tem)
6262

6363
# If you will be publishing to the PowerShell Gallery you will need a Nuget API key (can get from the website)
6464
# You should NOT enter this key here but rather manually enter it in the <%=$PLASTER_PARAM_ModuleName%>.buildenvironment.json file with: set-buildenvironment -NugetAPIKey '<key>'

‎plaster/ModuleBuild/scaffold/modulename.build.template‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,8 @@ task VersionCheck LoadModuleManifest, {
120120

121121
#Synopsis: Create a CodeHealthReport of your existing code
122122
task CodeHealthReport -if {$Script:BuildEnv.OptionCodeHealthReport} ValidateRequirements, LoadRequiredModules, {
123-
$BuildReportsFolder = Join-Path $BuildRoot $Script:BuildEnv.BuildReportsFolder
124-
Write-Description White "Creating a prebuild code health report of your public functions to $($Script:BuildEnv.BuildReportsFolder)" -accent
123+
$BuildReportsFolder = Join-Path $BuildRoot $(Join-Path $Script:BuildEnv.BuildReportsFolder $Script:BuildEnv.ModuleVersion)
124+
Write-Description White "Creating a prebuild code health report of your public functions to $($BuildReportsFolder)" -accent
125125

126126
if (-not (Test-Path $BuildReportsFolder)) {
127127
[void](New-Item -Path $BuildReportsFolder -ItemType:Directory)

‎plaster/PlasterContent.ps1‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ $Content = @(
154154
},
155155
@{
156156
ContentType = 'templateFile'
157-
Source = 'scaffold\readme.md'
158-
Destination = 'Readme.md'
157+
Source = 'scaffold\README.md'
158+
Destination = 'README.md'
159159
},
160160
@{
161161
ContentType = 'templateFile'

‎release/0.2.4/docs/ModuleBuild.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: ModuleBuild
3-
Module Guid: 8f6090b4-6411-4949-a717-96d64a1cc5b3 8f6090b4-6411-4949-a717-96d64a1cc5b3
3+
Module Guid: 8f6090b4-6411-4949-a717-96d64a1cc5b3
44
Download Help Link: https://github.com/zloeber/ModuleBuild/release/ModuleBuild/docs/ModuleBuild.md
55
Help Version: 0.2.4
66
Locale: en-US

release/0.2.4/en-US/ModuleBuild_8f6090b4-6411-4949-a717-96d64a1cc5b3 8f6090b4-6411-4949-a717-96d64a1cc5b3_HelpInfo.xml renamed to release/0.2.4/en-US/ModuleBuild_8f6090b4-6411-4949-a717-96d64a1cc5b3_HelpInfo.xml

File renamed without changes.

0 commit comments

Comments
 (0)