Skip to content

Commit

Permalink
Fixed use of parameters
Browse files Browse the repository at this point in the history 
Parameters like `-Raw` can be shorten with `-r` which is a valid parameter for a git command
  • Loading branch information
@lipkau
lipkau committed Jan 2, 2019
1 parent d07e22a commit 9bbb930
Show file tree
Hide file tree
Showing 5 changed files with 308 additions and 111 deletions.
16 changes: 8 additions & 8 deletions BuildHelpers/Public/Get-BuildVariable.ps1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ function Get-BuildVariable {
{
# Using older than 1.6.3 in your build system? Yuck
# Thanks to earl: http://stackoverflow.com/a/1418022/3067642
$BuildBranch = Invoke-Git @IGParams -Arguments "rev-parse --abbrev-ref HEAD"
$BuildBranch = (Invoke-Git @IGParams -Arguments "rev-parse --abbrev-ref HEAD").Output
}
}

Expand All @@ -156,42 +156,42 @@ function Get-BuildVariable {
'CI_COMMIT_SHA' {
if($WeCanGit)
{
Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )"
(Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )").Output
break
} # Gitlab 9.0+ - thanks to mipadi http://stackoverflow.com/a/3357357/3067642
}
'CI_BUILD_REF' {
if($WeCanGit)
{
Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )"
(Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )").Output
break
} # Gitlab 8.x - thanks to mipadi http://stackoverflow.com/a/3357357/3067642
}
'GIT_COMMIT' {
if($WeCanGit)
{
Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )"
(Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )").Output
break
} # Jenkins - thanks to mipadi http://stackoverflow.com/a/3357357/3067642
}
'BUILD_SOURCEVERSION' {
if($WeCanGit)
{
Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )"
(Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )").Output
break
} # VSTS (https://www.visualstudio.com/en-us/docs/build/define/variables#)
}
'BUILD_VCS_NUMBER' {
if($WeCanGit)
{
Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )"
(Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )").Output
break
} # Teamcity https://confluence.jetbrains.com/display/TCD10/Predefined+Build+Parameters
}
'BAMBOO_REPOSITORY_REVISION_NUMBER' {
if($WeCanGit)
{
Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )"
(Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )").Output
break
} # Bamboo https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html
}
Expand All @@ -204,7 +204,7 @@ function Get-BuildVariable {
{
if($WeCanGit)
{
$CommitMessage = Invoke-Git @IGParams -Arguments "log --format=%B -n 1"
$CommitMessage = (Invoke-Git @IGParams -Arguments "log --format=%B -n 1").Output
}
}

Expand Down
235 changes: 235 additions & 0 deletions BuildHelpers/Public/Get-BuildVariables.ps1
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,235 @@
function Get-BuildVariables {
<#
.SYNOPSIS
Normalize build system variables
.FUNCTIONALITY
CI/CD
.DESCRIPTION
Normalize build system variables
Each build system exposes common variables it's own unique way, if at all.
This function was written to enable more portable builds, and
to avoid tightly coupling your build scripts with your build system
Gathers from:
AppVeyor
GitLab CI
Jenkins
Teamcity
VTFS
Bamboo
GoCD
Travis CI
For Teamcity the VCS Checkout Mode needs to be to checkout files on agent.
Since TeamCity 10.0, this is the default setting for the newly created build configurations.
Git needs to be available on the agent for this.
Produces:
BuildSystem: Build system we're running under
ProjectPath: Project root for cloned repo
BranchName: git branch for this build
CommitMessage: git commit message for this build
BuildNumber: Build number provided by the CI system
.PARAMETER Path
Path to project root. Defaults to the current working path
.PARAMETER GitPath
Path to git. Defaults to git (i.e. git is in $ENV:PATH)
.NOTES
We assume you are in the project root, for several of the fallback options
.EXAMPLE
Get-BuildVariables
.LINK
https://github.com/RamblingCookieMonster/BuildHelpers
.LINK
Get-ProjectName
.LINK
Set-BuildEnvironment
.LINK
about_BuildHelpers
#>
[cmdletbinding()]
param(
$Path = $PWD.Path,
[validatescript({
if(-not (Get-Command $_ -ErrorAction SilentlyContinue))
{
throw "Could not find command at GitPath [$_]"
}
$true
})]
$GitPath = 'git'
)

$Path = ( Resolve-Path $Path ).Path
$Environment = Get-Item ENV:
if(!$PSboundParameters.ContainsKey('GitPath')) {
$GitPath = (Get-Command $GitPath -ErrorAction SilentlyContinue)[0].Path
}

$WeCanGit = ( (Test-Path $( Join-Path $Path .git )) -and (Get-Command $GitPath -ErrorAction SilentlyContinue) )
if($WeCanGit)
{
$IGParams = @{
Path = $Path
GitPath = $GitPath
}
}
$tcProperties = Get-TeamCityProperties # Teamcity has limited ENV: values but dumps the build configuration in a properties file.

# Determine the build system:
$BuildSystem = switch ($Environment.Name)
{
'APPVEYOR_BUILD_FOLDER' { 'AppVeyor'; break }
'GITLAB_CI' { 'GitLab CI' ; break }
'JENKINS_URL' { 'Jenkins'; break }
'BUILD_DEFINITIONNAME' { 'VSTS'; break }
'TEAMCITY_VERSION' { 'Teamcity'; break }
'BAMBOO_BUILDKEY' { 'Bamboo'; break }
'GOCD_SERVER_URL' { 'GoCD'; break }
'TRAVIS' { 'Travis CI'; break }
}
if(-not $BuildSystem)
{
$BuildSystem = 'Unknown'
}

# Find the build folder based on build system
$BuildRoot = switch ($Environment.Name)
{
'APPVEYOR_BUILD_FOLDER' { (Get-Item -Path "ENV:$_").Value; break } # AppVeyor
'CI_PROJECT_DIR' { (Get-Item -Path "ENV:$_").Value; break } # GitLab CI
'WORKSPACE' { (Get-Item -Path "ENV:$_").Value; break } # Jenkins Jenkins... seems generic.
'SYSTEM_DEFAULTWORKINGDIRECTORY' { (Get-Item -Path "ENV:$_").Value; break } # VSTS (Visual studio team services)
'BAMBOO_BUILD_WORKING_DIRECTORY' { (Get-Item -Path "ENV:$_").Value; break } # Bamboo
'TRAVIS_BUILD_DIR' { (Get-Item -Path "ENV:$_").Value; break } # Travis CI
}
if(-not $BuildRoot)
{
if ($BuildSystem -eq 'Teamcity') {
$BuildRoot = $tcProperties['teamcity.build.checkoutDir']
} else {
# Assumption: this function is defined in a file at the root of the build folder
$BuildRoot = $Path
}
}

# Find the git branch
$BuildBranch = switch ($Environment.Name)
{
'APPVEYOR_REPO_BRANCH' { (Get-Item -Path "ENV:$_").Value; break } # AppVeyor
'CI_COMMIT_REF_NAME' { (Get-Item -Path "ENV:$_").Value; break } # GitLab CI 9.0+
'CI_BUILD_REF_NAME' { (Get-Item -Path "ENV:$_").Value; break } # GitLab CI 8.x
'GIT_BRANCH' { (Get-Item -Path "ENV:$_").Value; break } # Jenkins
'BUILD_SOURCEBRANCHNAME' { (Get-Item -Path "ENV:$_").Value; break } # VSTS
'BAMBOO_REPOSITORY_GIT_BRANCH' { (Get-Item -Path "ENV:$_").Value; break } # Bamboo
'TRAVIS_BRANCH' { (Get-Item -Path "ENV:$_").Value; break } # Travis CI
}
if(-not $BuildBranch)
{
if($WeCanGit)
{
# Using older than 1.6.3 in your build system? Yuck
# Thanks to earl: http://stackoverflow.com/a/1418022/3067642
$BuildBranch = (Invoke-Git @IGParams -Arguments "rev-parse --abbrev-ref HEAD").Output
}
}

# Find the git commit message
$CommitMessage = switch ($Environment.Name)
{
'APPVEYOR_REPO_COMMIT_MESSAGE' {
"$env:APPVEYOR_REPO_COMMIT_MESSAGE $env:APPVEYOR_REPO_COMMIT_MESSAGE_EXTENDED".TrimEnd()
break
}
'CI_COMMIT_SHA' {
if($WeCanGit)
{
(Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )").Output
break
} # Gitlab 9.0+ - thanks to mipadi http://stackoverflow.com/a/3357357/3067642
}
'CI_BUILD_REF' {
if($WeCanGit)
{
(Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )").Output
break
} # Gitlab 8.x - thanks to mipadi http://stackoverflow.com/a/3357357/3067642
}
'GIT_COMMIT' {
if($WeCanGit)
{
(Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )").Output
break
} # Jenkins - thanks to mipadi http://stackoverflow.com/a/3357357/3067642
}
'SYSTEM_TEAMPROJECT' {
if($WeCanGit)
{
(Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )").Output
break
} # VSTS (https://www.visualstudio.com/en-us/docs/build/define/variables#)
}
'BUILD_VCS_NUMBER' {
if($WeCanGit)
{
(Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )").Output
break
} # Teamcity https://confluence.jetbrains.com/display/TCD10/Predefined+Build+Parameters
}
'BAMBOO_REPOSITORY_REVISION_NUMBER' {
if($WeCanGit)
{
(Invoke-Git @IGParams -Arguments "log --format=%B -n 1 $( (Get-Item -Path "ENV:$_").Value )").Output
break
} # Bamboo https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html
}
'TRAVIS_COMMIT_MESSAGE' {
"$env:TRAVIS_COMMIT_MESSAGE"
break
}
}
if(-not $CommitMessage)
{
if($WeCanGit)
{
$CommitMessage = (Invoke-Git @IGParams -Arguments "log --format=%B -n 1").Output
}
}

# Build number
$BuildNumber = switch ($Environment.Name)
{
'APPVEYOR_BUILD_NUMBER' { (Get-Item -Path "ENV:$_").Value; break } # AppVeyor
'CI_JOB_ID' { (Get-Item -Path "ENV:$_").Value; break } # GitLab CI 9.0+ - not perfect https://gitlab.com/gitlab-org/gitlab-ce/issues/3691
'CI_BUILD_ID' { (Get-Item -Path "ENV:$_").Value; break } # GitLab CI 8.x - not perfect https://gitlab.com/gitlab-org/gitlab-ce/issues/3691
'BUILD_NUMBER' { (Get-Item -Path "ENV:$_").Value; break } # Jenkins, Teamcity ... seems generic.
'BUILD_BUILDNUMBER' { (Get-Item -Path "ENV:$_").Value; break } # VSTS
'BAMBOO_BUILDNUMBER' { (Get-Item -Path "ENV:$_").Value; break } # Bamboo
'GOCD_PIPELINE_COUNTER' { (Get-Item -Path "ENV:$_").Value; break } # GoCD
'TRAVIS_BUILD_NUMBER' { (Get-Item -Path "ENV:$_").Value; break } # Travis CI
}
if(-not $BuildNumber)
{
$BuildNumber = 0
}

[pscustomobject]@{
BuildSystem = $BuildSystem
ProjectPath = $BuildRoot
BranchName = $BuildBranch
CommitMessage = $CommitMessage
BuildNumber = $BuildNumber
}
}
6 changes: 3 additions & 3 deletions BuildHelpers/Public/Get-GitChangedFile.ps1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ function Get-GitChangedFile {
[switch]$Resolve
)
$Path = (Resolve-Path $Path).Path
$GitPathRaw = Invoke-Git rev-parse --show-toplevel -Path $Path
$GitPathRaw = (Invoke-Git rev-parse --show-toplevel -Path $Path).Output
Write-Verbose "Found git root [$GitPathRaw]"
$GitPath = Resolve-Path $GitPathRaw
if(Test-Path $GitPath)
Expand All @@ -76,14 +76,14 @@ function Get-GitChangedFile {

if(-not $PSBoundParameters.ContainsKey('Commit'))
{
$Commit = Invoke-Git rev-parse HEAD -Path $GitPath
$Commit = (Invoke-Git rev-parse HEAD -Path $GitPath).Output
}
if(-not $Commit)
{
return
}

[string[]]$Files = Invoke-Git "diff-tree --no-commit-id --name-only -r $Commit" -Path $GitPath
[string[]]$Files = (Invoke-Git diff-tree --no-commit-id --name-only -r $Commit -Path $GitPath).Output
if($Files.Count -gt 0)
{
$Params = @{Collection = $Files}
Expand Down
Loading

0 comments on commit 9bbb930

Please sign in to comment.