Merge branch 'release/1.3.0'

abbgrade · Aug 7, 2022 · d2fd075 · d2fd075
2 parents 050fdd1 + 0b6eb97
commit d2fd075
Show file tree

Hide file tree

Showing 14 changed files with 125 additions and 21 deletions.
diff --git a/.github/workflows/build-validation.yml b/.github/workflows/build-validation.yml
@@ -6,4 +6,4 @@ on:
 
 jobs:
   build-validation:
-    uses: abbgrade/PsBuildTasks/.github/workflows/build-validation-matrix.yml@v1.1
+    uses: abbgrade/PsBuildTasks/.github/workflows/build-validation-matrix.yml@1.4.0
diff --git a/.github/workflows/pre-release.yml b/.github/workflows/pre-release.yml
@@ -5,7 +5,7 @@ on:
 
 jobs:
   pre-release:
-    uses: abbgrade/PsBuildTasks/.github/workflows/pre-release-windows.yml@v1.1
+    uses: abbgrade/PsBuildTasks/.github/workflows/pre-release-windows.yml@1.4.0
     with:
       module-name: PsSqlTestServer
     secrets:

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -5,7 +5,7 @@ on:
 
 jobs:
   release:
-    uses: abbgrade/PsBuildTasks/.github/workflows/release-windows.yml@v1.1
+    uses: abbgrade/PsBuildTasks/.github/workflows/release-windows.yml@1.4.0
     with:
       module-name: PsSqlTestServer
     secrets:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,9 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.3.0] - 2022-08-07
+
 ### Added
 
-- New-AzureInstance, Remove-AzureInstance
+- New-AzureInstance, Remove-AzureInstance and New-DatabaseName commands
 
 ### Changed
 

diff --git a/docs/New-SqlTestDatabase.md b/docs/New-SqlTestDatabase.md
@@ -79,7 +79,7 @@ Aliases:
 
 Required: False
 Position: 3
-Default value: ( [string](New-Guid) ).Substring(0, 8)
+Default value: ( New-DatabaseName )
 Accept pipeline input: False
 Accept wildcard characters: False
 ```

diff --git a/docs/New-SqlTestDatabaseName.md b/docs/New-SqlTestDatabaseName.md
@@ -0,0 +1,57 @@
+---
+external help file: PsSqlTestServer-help.xml
+Module Name: PsSqlTestServer
+online version:
+schema: 2.0.0
+---
+
+# New-SqlTestDatabaseName
+
+## SYNOPSIS
+Generates a database name.
+
+## SYNTAX
+
+```
+New-SqlTestDatabaseName [[-Prefix] <String>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Generates a short random database name.
+
+## EXAMPLES
+
+### Example 1
+```powershell
+PS C:\> {{ Add example code here }}
+```
+
+{{ Add example description here }}
+
+## PARAMETERS
+
+### -Prefix
+Prefix to the database name.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 1
+Default value: Test-
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS
diff --git a/docs/New-SqlTestLocalInstance.md b/docs/New-SqlTestLocalInstance.md
@@ -46,7 +46,7 @@ Aliases:
 
 Required: False
 Position: 1
-Default value: "test-$(( [string](New-Guid) ).Substring(0, 8))"
+Default value: "test-$( New-DatabaseName )"
 Accept pipeline input: False
 Accept wildcard characters: False
 ```

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1 +0,0 @@
-theme: jekyll-theme-minimal

diff --git a/src/PsSqlTestServer.psd1 b/src/PsSqlTestServer.psd1
@@ -12,7 +12,7 @@
 RootModule = 'PsSqlTestServer.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.2.0'
+ModuleVersion = '1.3.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

diff --git a/src/Public/New-Database.ps1 b/src/Public/New-Database.ps1
@@ -38,7 +38,7 @@ function New-Database {
         # Specifies the name of the database to create.
         [Parameter()]
         [ValidateNotNullOrEmpty()]
-        [string] $Name = ( [string](New-Guid) ).Substring(0, 8)
+        [string] $Name = ( New-DatabaseName )
     )
 
     $Database = $Instance.PsObject.Copy()

diff --git a/src/Public/New-DatabaseName.ps1 b/src/Public/New-DatabaseName.ps1
@@ -0,0 +1,26 @@
+function New-DatabaseName {
+
+    <#
+
+    .SYNOPSIS
+    Generates a database name.
+
+    .DESCRIPTION
+    Generates a short random database name.
+
+    #>
+
+    [CmdletBinding()]
+    param (
+        # Prefix to the database name.
+        [Parameter()]
+        [string] $Prefix = 'test-'
+    )
+
+    if ( $Prefix ) {
+        Write-Output "$Prefix$( ( [string](New-Guid) ).Substring(0, 8) )"
+    } else {
+        Write-Output ( [string](New-Guid) ).Substring(0, 8)
+    }
+
+}
diff --git a/src/Public/New-LocalInstance.ps1 b/src/Public/New-LocalInstance.ps1
@@ -26,7 +26,7 @@ function New-LocalInstance {
         # Specifies the name of the instance to create.
         [Parameter()]
         [ValidateNotNullOrEmpty()]
-        [string] $Name = "test-$(( [string](New-Guid) ).Substring(0, 8))"
+        [string] $Name = "test-$( New-DatabaseName )"
     )
 
     Import-Module PsSqlLocalDb -ErrorAction Stop

diff --git a/tasks/Build.Tasks.ps1 b/tasks/Build.Tasks.ps1
@@ -8,7 +8,8 @@ requires ModuleName
 
 # Synopsis: Remove all temporary files.
 task Clean -Jobs {
-	remove $PublishDirectory, $DocumentationDirectory
+	remove $PublishDirectory
+	$DocumentationDirectory | Get-ChildItem -Exclude index.md, _config.yml | Remove-item
 }
 
 # Synopsis: Import the module.

diff --git a/tasks/PsBuild.Tasks.ps1 b/tasks/PsBuild.Tasks.ps1
@@ -1,47 +1,66 @@
+
+if ( -Not $PsBuildTaskBranch ) {
+    $PsBuildTaskBranch = 'main'
+}
+
 #region InvokeBuild
 
 task UpdateBuildTasks {
 	Invoke-WebRequest `
-		-Uri 'https://raw.githubusercontent.com/abbgrade/PsBuildTasks/main/Powershell/Build.Tasks.ps1' `
+		-Uri "https://raw.githubusercontent.com/abbgrade/PsBuildTasks/$PsBuildTaskBranch/Powershell/Build.Tasks.ps1" `
 		-OutFile "$PSScriptRoot\Build.Tasks.ps1"
 }
 
 #endregion
 #region GitHub Actions
 
 task UpdateValidationWorkflow {
+    [System.IO.FileInfo] $file = "$PSScriptRoot/../.github/workflows/build-validation.yml"
+    New-Item -Type Directory $file.Directory -ErrorAction SilentlyContinue
     Invoke-WebRequest `
-        -Uri 'https://raw.githubusercontent.com/abbgrade/PsBuildTasks/main/GitHub/build-validation-matrix.yml' `
-        -OutFile "$PSScriptRoot\..\.github\workflows\build-validation.yml"
+        -Uri "https://raw.githubusercontent.com/abbgrade/PsBuildTasks/$PsBuildTaskBranch/GitHub/build-validation-matrix.yml" `
+        -OutFile $file
 }
 
 task UpdatePreReleaseWorkflow {
+    requires ModuleName
+    [System.IO.FileInfo] $file = "$PSScriptRoot\..\.github\workflows\pre-release.yml"
+    New-Item -Type Directory $file.Directory -ErrorAction SilentlyContinue
     Invoke-WebRequest `
-        -Uri 'https://raw.githubusercontent.com/abbgrade/PsBuildTasks/main/GitHub/pre-release-windows.yml' `
-        -OutFile "$PSScriptRoot\..\.github\workflows\pre-release.yml"
+        -Uri "https://raw.githubusercontent.com/abbgrade/PsBuildTasks/$PsBuildTaskBranch/GitHub/pre-release-windows.yml" |
+    ForEach-Object { $_ -replace 'MyModuleName', $ModuleName } |
+    Out-File $file -NoNewline
 }
 
 task UpdateReleaseWorkflow {
+    requires ModuleName
+    [System.IO.FileInfo] $file = "$PSScriptRoot\..\.github\workflows\release.yml"
+    New-Item -Type Directory $file.Directory -ErrorAction SilentlyContinue
     Invoke-WebRequest `
-        -Uri 'https://raw.githubusercontent.com/abbgrade/PsBuildTasks/main/GitHub/release-windows.yml' `
-        -OutFile "$PSScriptRoot\..\.github\workflows\release.yml"
+        -Uri "https://raw.githubusercontent.com/abbgrade/PsBuildTasks/$PsBuildTaskBranch/GitHub/release-windows.yml" |
+    ForEach-Object { $_ -replace 'MyModuleName', $ModuleName } |
+    Out-File $file -NoNewline
 }
 
 #endregion
 #region GitHub Pages
 
 task UpdateIndexPage {
+    New-Item -Type Directory "$PSScriptRoot\..\docs" -ErrorAction SilentlyContinue
     Invoke-WebRequest `
-        -Uri 'https://raw.githubusercontent.com/abbgrade/PsBuildTasks/main/docs/index.md' `
+        -Uri "https://raw.githubusercontent.com/abbgrade/PsBuildTasks/$PsBuildTaskBranch/docs/index.md" `
         -OutFile "$PSScriptRoot\..\docs\index.md"
+    Invoke-WebRequest `
+        -Uri "https://raw.githubusercontent.com/abbgrade/PsBuildTasks/$PsBuildTaskBranch/docs/_config.yml" `
+        -OutFile "$PSScriptRoot\..\docs\_config.yml"
 }
 
 #endregion
 #region VsCode
 
 task UpdateVsCodeTasks {
     Invoke-WebRequest `
-        -Uri 'https://raw.githubusercontent.com/abbgrade/PsBuildTasks/main/VsCode/tasks.json' `
+        -Uri "https://raw.githubusercontent.com/abbgrade/PsBuildTasks/$PsBuildTaskBranch/VsCode/tasks.json" `
         -OutFile "$PSScriptRoot\..\.vscode\tasks.json"
 }
 
@@ -50,7 +69,7 @@ task UpdateVsCodeTasks {
 
 task UpdatePsBuildTasksTasks {
     Invoke-WebRequest `
-        -Uri 'https://raw.githubusercontent.com/abbgrade/PsBuildTasks/main/tasks/PowerShell-Matrix.Tasks.ps1' `
+        -Uri "https://raw.githubusercontent.com/abbgrade/PsBuildTasks/$PsBuildTaskBranch/tasks/PowerShell-Matrix.Tasks.ps1" `
         -OutFile "$PSScriptRoot\PsBuild.Tasks.ps1"
 }