Skip to content

Commit 49370bd

Browse files
committed
0.0.3 updates
1 parent 7d35743 commit 49370bd

19 files changed

Lines changed: 29 additions & 31 deletions

ModuleBuild.build.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -663,6 +663,7 @@ task CreateProjectHelp BuildProjectHelpFiles, AddAdditionalDocFiles, UpdateReadT
663663
task PublishPSGallery LoadBuildTools, {
664664
Write-Description White 'Publishing recent module release to the PowerShell Gallery' -accent
665665

666+
$ReleasePath = Join-Path $BuildRoot $Script:BuildEnv.BaseReleaseFolder
666667
$CurrentReleasePath = Join-Path $ReleasePath $Script:BuildEnv.ModuleToBuild
667668
if (Get-Module $Script:BuildEnv.ModuleToBuild) {
668669
# If the module is already loaded then unload it.

ModuleBuild.psd1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: Zachary Loeber
55
#
6-
# Generated on: 6/11/2017
6+
# Generated on: 6/12/2017
77
#
88

99
@{
@@ -107,7 +107,7 @@ PrivateData = @{
107107
IconUri = 'https://github.com/zloeber/ModuleBuild/raw/master/src/other/powershell-project.png'
108108

109109
# ReleaseNotes of this module
110-
ReleaseNotes = 'First release'
110+
ReleaseNotes = '0.0.3 module updates'
111111

112112
# External dependent modules of this module
113113
# ExternalModuleDependencies = ''

Readme.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
11
# ModuleBuild
22

3-
A scaffolding framework which can be used to kickstart a generic PowerShell module project.
3+
A scaffolding framework which can be used to kickstart a generic PowerShell module project with a bunch of extras.
44

55
## Description
66

7-
A scaffolding framework which can be used to kickstart a generic PowerShell module project and much more. This project helps make everything about starting, documenting, building, and eventually releasing your module to the PSGallary a breeze.
8-
9-
## Introduction
10-
11-
A scaffolding framework which can be used to kickstart a generic PowerShell module project with an Invoke-Build backend for regular deployments and other automated tasks.
7+
A scaffolding framework which can be used to kickstart a generic PowerShell module project with an Invoke-Build backend for regular deployments and other automated tasks. This project helps make everything about starting, documenting, building, and eventually releasing your module to the PSGallary a breeze.
128

139
## Requirements
1410

1511
- PowerShell 5.0
1612

17-
- All other module requirements will be automatically installed at build time if they are not available.
13+
- All other module requirements will be automatically installed at build time if they are not available. (This is one of the reasons PowerShell 5 or greater is required)
1814

1915
## Installation
2016

build/docs/Additional/Contributing.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Finally, the Function documentation gets generated automatically based on the co
1212
## Development Environment
1313
While any text editor will work well there are included task and setting json files explicitly for Visual Studio Code included with this project. The following tasks have been defined to make things a bit easier. First access the 'Pallette' (Shift+Ctrl+P or Shift+Cmd+P) and start typing in any of the following tasks to find and run them:
1414

15-
- Clean -> Cleans out your scratch folder
1615
- Build -> Runs the Build task (also can use Shift+Ctrl+B or Shift+Cmd+B)
1716
- Analyze -> Runs PSScriptAnalyzer against the src/public files.
1817
- CreateProjectHelp - Creates the project level help.

docs/Contributing.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Finally, the Function documentation gets generated automatically based on the co
1212
## Development Environment
1313
While any text editor will work well there are included task and setting json files explicitly for Visual Studio Code included with this project. The following tasks have been defined to make things a bit easier. First access the 'Pallette' (Shift+Ctrl+P or Shift+Cmd+P) and start typing in any of the following tasks to find and run them:
1414

15-
- Clean -> Cleans out your scratch folder
1615
- Build -> Runs the Build task (also can use Shift+Ctrl+B or Shift+Cmd+B)
1716
- Analyze -> Runs PSScriptAnalyzer against the src/public files.
1817
- CreateProjectHelp - Creates the project level help.

plaster/ModuleBuild/plasterManifest.xml

Lines changed: 1 addition & 1 deletion
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>7f3b39ef-b0aa-4567-8bf4-921de706a3e1</id>
7+
<id>df3c3135-4058-4846-824e-60cc3c3bfff5</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>

plaster/ModuleBuild/scaffold/modulename.build.ps1

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ task CreateModulePSM1 RemoveScriptSignatures, UpdateCBH, {
349349

350350
# Synopsis: Removes script signatures before creating a combined PSM1 file
351351
task RemoveScriptSignatures {
352-
Write-Build White 'Removing any script signatures for function files (if they exist)' -Accent
352+
Write-Description White 'Removing any script signatures for function files (if they exist)' -Accent
353353

354354
$ScratchPath = Join-Path $BuildRoot $Script:BuildEnv.ScratchFolder
355355

@@ -380,7 +380,7 @@ task SanitizeCode -if {$Script:BuildEnv.OptionSanitizeSensitiveTerms} {
380380

381381
# Synopsis: Replace comment based help with external help in all public functions for this project
382382
task UpdateCBH {
383-
Write-Build White 'Updating Comment Based Help in functions to point to external help links' -accent
383+
Write-Description White 'Updating Comment Based Help in functions to point to external help links' -accent
384384

385385
$ExternalHelp = @"
386386
<#
@@ -425,10 +425,10 @@ task AnalyzePublic {
425425
$AnalysisErrors = @($Analysis | Where-Object {@('Information', 'Warning') -notcontains $_.Severity})
426426

427427
if ($AnalysisErrors.Count -ne 0) {
428-
Write-Build White 'The following errors came up in the script analysis:' -level 2
428+
Write-Description White 'The following errors came up in the script analysis:' -level 2
429429
$AnalysisErrors
430-
Write-Build
431-
Write-Build White "Note that this was from the script analysis run against $($Script:BuildEnv.PublicFunctionSource)" -level 2
430+
Write-Description
431+
Write-Description White "Note that this was from the script analysis run against $($Script:BuildEnv.PublicFunctionSource)" -level 2
432432
}
433433
}
434434

@@ -663,6 +663,7 @@ task CreateProjectHelp BuildProjectHelpFiles, AddAdditionalDocFiles, UpdateReadT
663663
task PublishPSGallery LoadBuildTools, {
664664
Write-Description White 'Publishing recent module release to the PowerShell Gallery' -accent
665665

666+
$ReleasePath = Join-Path $BuildRoot $Script:BuildEnv.BaseReleaseFolder
666667
$CurrentReleasePath = Join-Path $ReleasePath $Script:BuildEnv.ModuleToBuild
667668
if (Get-Module $Script:BuildEnv.ModuleToBuild) {
668669
# If the module is already loaded then unload it.

release/0.0.3/ModuleBuild.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ PrivateData = @{
108108
IconUri = 'https://github.com/zloeber/ModuleBuild/raw/master/src/other/powershell-project.png'
109109

110110
# ReleaseNotes of this module
111-
ReleaseNotes = 'First release'
111+
ReleaseNotes = '0.0.3 module updates'
112112

113113
# External dependent modules of this module
114114
# ExternalModuleDependencies = ''
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)