Add scripts to handle PR flow

rasmusjelsgaard · rasmusjelsgaard · commit 9017ebb4a013 · 2019-06-03T13:30:26.000+02:00
Logic to point to the last commit of branch being reviewed in PR
Set correct requirements psake and pester
Use deploy instead of stages
Only deploy on master when tagged
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,36 @@
+sudo: required
+
+language: csharp
+dotnet: 2.1
+mono: none
+
+services:
+  - docker
+
+dist: trusty
+addons:
+    apt:
+        sources:
+        - sourceline: "deb [arch=amd64] https://packages.microsoft.com/ubuntu/14.04/prod trusty main"
+          key_url: "https://packages.microsoft.com/keys/microsoft.asc"
+        packages:
+            - powershell
+
+before_install:
+  - chmod ugo+x ./scripts/setup_repo.sh && ./scripts/setup_repo.sh
+  - sudo apt-get install -y powershell
+
+install:
+  - pwsh -f "./Install-Prerequisites.ps1"
+  - export GitVersion_Version=$(docker run --rm -v "$(pwd):/repo" gittools/gitversion:5.0.0-linux-debian-9-netcoreapp2.2 /repo -output json -showvariable majorminorpatch)
+  - "echo \"GitVersion says: ${GitVersion_Version} \""
+
+script:
+  - pwsh -c "Invoke-Psake -buildFile Build.ps1 -taskList build,test"
+
+deploy:
+  provider: script
+  script: pwsh -c "Invoke-Psake -buildFile Build.ps1 -taskList build,test,publish"
+  on:
+    tags: true
+    branch: master
diff --git a/Build.ps1 b/Build.ps1
@@ -1,43 +1,3 @@
-# This is a PSake script that supports the following tasks:
-# clean, build, test and publish.  The default task is build.
-#
-# The publish task uses the Publish-Module command to publish
-# to either the PowerShell Gallery (the default) or you can change
-# the $Repository property to the name of an alternate repository.
-#
-# The test task invokes Pester to run any Pester tests in your
-# workspace folder. Name your test scripts <TestName>.Tests.ps1
-# and Pester will find and run the tests contained in the files.
-#
-# You can run this build script directly using the invoke-psake
-# command which will execute the build task.  This task "builds"
-# a temporary folder from which the module can be published.
-#
-# PS C:\> invoke-psake build.ps1
-#
-# You can run your Pester tests (if any) by running the following command.
-#
-# PS C:\> invoke-psake build.ps1 -taskList test
-#
-# You can execute the publish task with the following command. Note that
-# the publish task will run the test task first. The Pester tests must pass
-# before the publish task will run.  The first time you run the publish
-# command, you will be prompted to enter your PowerShell Gallery NuGetApiKey.
-# After entering the key, it is encrypted and stored so you will not have to
-# enter it again.
-#
-# PS C:\> invoke-psake build.ps1 -taskList publish
-#
-# You can verify the stored and encrypted NuGetApiKey by running the following
-# command. This will display your NuGetApiKey in plain text!
-#
-# PS C:\> invoke-psake build.ps1 -taskList showKey
-#
-# You can store a new NuGetApiKey with this command. You can leave off
-# the -properties parameter and you'll be prompted for the key.
-#
-# PS C:\> invoke-psake build.ps1 -taskList storeKey -properties @{NuGetApiKey='test123'}
-#
 
 ###############################################################################
 # Customize these properties for your module.
@@ -63,31 +23,18 @@ Properties {
         (Split-Path $PSCommandPath -Leaf)
     )
 
-    # Name of the repository you wish to publish to. Default repo is the PSGallery.
-    $PublishRepository = $null
-
-    # Your NuGet API key for the PSGallery.  Leave it as $null and the first time
-    # you publish you will be prompted to enter your API key.  The build will
-    # store the key encrypted in a file, so that on subsequent publishes you
-    # will no longer be prompted for the API key.
-    $NuGetApiKey = $null
-    $EncryptedApiKeyPath = "$env:LOCALAPPDATA\vscode-powershell\NuGetApiKey.clixml"
 }
 
 ###############################################################################
 # Customize these tasks for performing operations before and/or after publish.
 ###############################################################################
 Task PrePublish {
     $functionDeclarations  = @( Get-ChildItem -Path $PublishDir\Public\*.ps1 -ErrorAction SilentlyContinue )
-    $functionNames = @()
-    foreach ($function in $functionDeclarations) {
-        $functionNames += $function.BaseName
-    }
-    $functionsToExport = $functionNames -join ","
+    [string[]]$functionNames = @($functionDeclarations.BaseName)
 
     Update-ModuleManifest -Path $PublishDir\${ModuleName}.psd1 `
-        -ModuleVersion "0.0.14" `
-        -FunctionsToExport $functionsToExport
+        -ModuleVersion "$env:GitVersion_Version" `
+        -FunctionsToExport $functionNames
 }
 
 Task PostPublish {
@@ -102,8 +49,8 @@ Task default -depends Build
 Task Publish -depends Test, PrePublish, PublishImpl, PostPublish {
 }
 
-Task PublishImpl -depends Test -requiredVariables PublishDir, EncryptedApiKeyPath {
-    $NuGetApiKey = Get-NuGetApiKey $NuGetApiKey $EncryptedApiKeyPath
+Task PublishImpl -depends Test -requiredVariables PublishDir {
+    $NuGetApiKey = $env:PSGalleryAPIToken
 
     $publishParams = @{
         Path        = $PublishDir
@@ -119,7 +66,7 @@ Task PublishImpl -depends Test -requiredVariables PublishDir, EncryptedApiKeyPat
 
 Task Test -depends Build {
     Import-Module Pester
-    Invoke-Pester $PSScriptRoot
+    Invoke-Pester $PSScriptRoot/Tests
 }
 
 Task Build -depends Clean -requiredVariables PublishDir, Exclude, ModuleName {
@@ -148,58 +95,7 @@ Task Init -requiredVariables PublishDir {
    }
 }
 
-Task StoreKey -requiredVariables EncryptedApiKeyPath {
-    if (Test-Path $EncryptedApiKeyPath) {
-        Remove-Item $EncryptedApiKeyPath
-    }
-
-    $null = Get-NuGetApiKey $NuGetApiKey $EncryptedApiKeyPath
-    "The NuGetApiKey has been stored in $EncryptedApiKeyPath"
-}
-
-Task ShowKey -requiredVariables EncryptedApiKeyPath {
-    $NuGetApiKey = Get-NuGetApiKey $NuGetApiKey $EncryptedApiKeyPath
-    "The stored NuGetApiKey is: $NuGetApiKey"
-}
-
 Task ? -description 'Lists the available tasks' {
     "Available tasks:"
     $psake.context.Peek().tasks.Keys | Sort
 }
-
-###############################################################################
-# Helper functions
-###############################################################################
-function Get-NuGetApiKey($NuGetApiKey, $EncryptedApiKeyPath) {
-    $storedKey = $null
-    if (!$NuGetApiKey) {
-        if (Test-Path $EncryptedApiKeyPath) {
-            $storedKey = Import-Clixml $EncryptedApiKeyPath | ConvertTo-SecureString
-            $cred = New-Object -TypeName PSCredential -ArgumentList 'kh',$storedKey
-            $NuGetApiKey = $cred.GetNetworkCredential().Password
-            Write-Verbose "Retrieved encrypted NuGetApiKey from $EncryptedApiKeyPath"
-        }
-        else {
-            $apiKeySS = Read-Host -Prompt "Enter your NuGet API Key" -AsSecureString
-            $cred = New-Object -TypeName PSCredential -ArgumentList 'dw',$apiKeySS
-            $NuGetApiKey = $cred.GetNetworkCredential().Password
-        }
-    }
-
-    if (!$storedKey) {
-        # Store encrypted NuGet API key to use for future invocations
-        if (!$apiKeySS) {
-            $apiKeySS = ConvertTo-SecureString -String $NuGetApiKey -AsPlainText -Force
-        }
-
-        $parentDir = Split-Path $EncryptedApiKeyPath -Parent
-        if (!(Test-Path -Path $parentDir)) {
-            $null = New-Item -Path $parentDir -ItemType Directory
-        }
-
-        $apiKeySS | ConvertFrom-SecureString | Export-Clixml $EncryptedApiKeyPath
-        Write-Verbose "Stored encrypted NuGetApiKey to $EncryptedApiKeyPath"
-    }
-
-    $NuGetApiKey
-}
diff --git a/GitVersion.yml b/GitVersion.yml
@@ -0,0 +1,4 @@
+mode: ContinuousDelivery
+branches: {}
+ignore:
+  sha: []
diff --git a/Install-Prerequisites.ps1 b/Install-Prerequisites.ps1
@@ -0,0 +1,6 @@
+# The psake module is needed to run tests and publish the module to powershell gallery.
+Set-PSRepository -Name "PSGallery" -InstallationPolicy Trusted
+Install-Module -Name psake -RequiredVersion 4.8.0 -Repository "PSGallery"
+Install-Module -Name pester -RequiredVersion 4.8.0 -Repository "PSGallery"
+
+
diff --git a/ReleaseNotes.md b/ReleaseNotes.md
@@ -1,4 +1,6 @@
-Release Notes for v0.0.14
-====================================
+# Release Notes
+
+## v0.1.0
+Initial version that supports making basic requests to Jenkins via the Remote API.
+Includes convenience functions to make and delete jobs.
 
-Really nothing special to note yet.
diff --git a/ThreeShape.Jenkins.psd1 b/ThreeShape.Jenkins.psd1
@@ -1,7 +1,7 @@
 #
 # Module manifest for module 'ThreeShape.Jenkins'
 #
-# Generated by: BAT
+# Generated by: 3Shape A/S
 #
 # Generated on: 03/05/2019
 #
@@ -12,7 +12,7 @@
     RootModule = 'ThreeShape.Jenkins.psm1'
 
     # Version number of this module.
-    ModuleVersion = '0.0.14'
+    ModuleVersion = '0.1.0'
 
     # Supported PSEditions
     CompatiblePSEditions = 'Core'
@@ -27,10 +27,10 @@
     CompanyName = '3Shape'
 
     # Copyright statement for this module
-    Copyright = '(c) 2019 3Shape. All rights reserved.'
+    Copyright = '(c) 2019 3Shape, licensed under the Apache 2.0 license.'
 
     # Description of the functionality provided by this module
-    Description = 'PowerShell module to work with Jenkins'
+    Description = 'PowerShell module to interact with the Jenkins Remote Access API. The module aims to wrap the API endpoints and expose them in a way that should look and feel familiar to Powershell developers.'
 
     # Minimum version of the Windows PowerShell engine required by this module
     PowerShellVersion = '6.0'
@@ -80,25 +80,16 @@
     # Aliases to export from this module
     AliasesToExport = '*'
 
-    # DSC resources to export from this module
-    # DscResourcesToExport = @()
-
-    # List of all modules packaged with this module
-    # ModuleList = @()
-
-    # List of all files packaged with this module
-    # FileList = @()
-
     # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
     PrivateData = @{
 
         PSData = @{
 
             # Tags applied to this module. These help with module discovery in online galleries.
-            # Tags = @()
+            Tags = @('powershell', 'powershell core', 'jenkins', 'hudson', 'api', 'PSEdition_Core', 'Windows', 'Linux')
 
             # A URL to the license for this module.
-            # LicenseUri = ''
+            LicenseUri = 'https://www.apache.org/licenses/LICENSE-2.0.txt'
 
             # A URL to the main website for this project.
             # ProjectUri = ''
diff --git a/scripts/setup_repo.sh b/scripts/setup_repo.sh
@@ -0,0 +1,14 @@
+#!/bin/bash
+# The git clone command in this script is needed because travis always performs git clone using a branch.
+# This makes it impossible to get all the branch and tag information needed without fully cloning.
+set -ev
+
+if [ "${TRAVIS_PULL_REQUEST}" = "false" ]; then
+  COMMIT_SHA=${TRAVIS_COMMIT}
+else
+  COMMIT_SHA=${TRAVIS_PULL_REQUEST_SHA}
+fi
+
+git clone https://github.com/$TRAVIS_REPO_SLUG.git $TRAVIS_REPO_SLUG
+cd $TRAVIS_REPO_SLUG
+git checkout -qf $COMMIT_SHA

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +mode: ContinuousDelivery
 +branches: {}
 +ignore:
 +  sha: []