initial commit

Author: devblackops

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.1.0] - Unreleased
+
+### Added
+
+- Initial commit

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Brandon Olin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,3 @@
+# PowerShellBuild.Common
+
+A common [psake](https://github.com/psake/psake) task module for PowerShell projects.

build.ps1

@@ -0,0 +1,30 @@
+[cmdletbinding(DefaultParameterSetName = 'Task')]
+param(
+    [parameter(ParameterSetName = 'task', position = 0)]
+    [string[]]$Task = 'default',
+
+    [parameter(ParameterSetName = 'Help')]
+    [switch]$Help
+)
+
+$ErrorActionPreference = 'Stop'
+
+# Bootstrap dependencies
+Get-PackageProvider -Name Nuget -ForceBootstrap | Out-Null
+Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
+if (-not (Get-Module -Name PSDepend -ListAvailable)) {
+    Install-module -Name PSDepend -Repository PSGallery
+}
+Import-Module -Name PSDepend
+Invoke-PSDepend -Path './requirements.psd1' -Install -Import -Force -WarningAction SilentlyContinue
+
+$psakeFile = './psakeFile.ps1'
+if ($PSCmdlet.ParameterSetName -eq 'Help') {
+    Get-PSakeScriptTasks -buildFile $psakeFile  |
+        Format-Table -Property Name, Description, Alias, DependsOn
+} else {
+    Set-BuildEnvironment -Force
+
+    Invoke-psake -buildFile $psakeFile -taskList $Task -nologo
+    exit ( [int]( -not $psake.build_success ) )
+}

build.settings.ps1

@@ -0,0 +1,12 @@
+$projectRoot = if ($ENV:BHProjectPath) { $ENV:BHProjectPath } else { $PSScriptRoot }
+
+@{
+    ProjectRoot     = $projectRoot
+    ProjectName     = $env:BHProjectName
+    SUT             = $env:BHModulePath
+    Tests           = Join-Path -Path $projectRoot -ChildPath Tests
+    ManifestPath    = $env:BHPSModuleManifest
+    Manifest        = Import-PowerShellDataFile -Path $env:BHPSModuleManifest
+    PSVersion       = $PSVersionTable.PSVersion.ToString()
+    PSGalleryApiKey = $env:PSGalleryApiKey
+}

media/psaketaskmodule-256x256.png

@@ -0,0 +1,46 @@
+properties {
+    $settings = . (Join-Path -path $PSScriptRoot -ChildPath build.settings.ps1)
+}
+
+task default -depends Test
+
+task Init {
+    "STATUS: Testing with PowerShell $($settings.PSVersion)"
+    'Build System Details:'
+    Get-Item ENV:BH*
+} -description 'Initialize build environment'
+
+task Test -Depends Init, Analyze, Pester -description 'Run test suite'
+
+task Analyze -depends Init {
+    $analysis = Invoke-ScriptAnalyzer -Path $settings.SUT -Recurse -Verbose:$false
+    $errors = $analysis | Where-Object {$_.Severity -eq 'Error'}
+    $warnings = $analysis | Where-Object {$_.Severity -eq 'Warning'}
+    if (@($errors).Count -gt 0) {
+        Write-Error -Message 'One or more Script Analyzer errors were found. Build cannot continue!'
+        $errors | Format-Table
+    }
+
+    if (@($warnings).Count -gt 0) {
+        Write-Warning -Message 'One or more Script Analyzer warnings were found. These should be corrected.'
+        $warnings | Format-Table
+    }
+} -description 'Run PSScriptAnalyzer'
+
+task Pester -depends Init {
+    Remove-Module $settings.ProjectName -ErrorAction SilentlyContinue -Verbose:$false
+    Import-Module -Name $settings.ManifestPath -Force -Verbose:$false
+
+    if (Test-Path -Path $settings.Tests) {
+        Invoke-Pester -Path $settings.Tests -PassThru -EnableExit
+    }
+} -description 'Run Pester tests'
+
+task Publish -depends Init {
+    "    Publishing version [$($settings.Manifest.ModuleVersion)] to PSGallery..."
+    if ($settings.PSGalleryApiKey) {
+        Publish-Module -Path $settings.SUT -NuGetApiKey $settings.PSGalleryApiKey -Repository PSGallery
+    } else {
+        throw 'Did not find PSGallery API key!'
+    }
+} -description 'Publish to PowerShellGallery'

psakeFile.ps1

@@ -0,0 +1,6 @@
+@{
+    BuildHelpers     = 'latest'
+    Pester           = 'latest'
+    psake            = 'latest'
+    PSScriptAnalyzer = 'latest'
+}

requirements.psd1

@@ -0,0 +1,24 @@
+@{
+    RootModule        = 'PowerShellBuild.Common'
+    ModuleVersion     = '0.1.0'
+    GUID              = '15431eb8-be2d-4154-b8ad-4cb68a488e3d'
+    Author            = 'Brandon Olin'
+    CompanyName       = 'Community'
+    Copyright         = '(c) Brandon Olin. All rights reserved.'
+    Description       = 'A common psake task module for PowerShell projects'
+    PowerShellVersion = '3.0'
+    RequiredModules   = @('BuildHelpers', 'psake')
+    FunctionsToExport = '*'
+    CmdletsToExport   = @()
+    VariablesToExport = @()
+    AliasesToExport   = @()
+    PrivateData       = @{
+        PSData = @{
+            Tags = @('psake', 'build')
+            # LicenseUri = ''
+            # ProjectUri = ''
+            # IconUri = ''
+            # ReleaseNotes = ''
+        }
+    }
+}