Skip to content

Commit 2d7d9be

Browse files
committed
Added fine grain controls of extended integration features
1 parent eedadec commit 2d7d9be

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ For all commits, the build metadata will include the CI environment and a releva
5757

5858
|Integration|Configuration Tag|Notes|
5959
|-|-|-|
60-
|[GitHub Actions](https://github.com/features/actions)|`<BuildVersioningWithGitHub>`|GitHub Actions don't fetch tags by default. This integration will perform a `git fetch` for tags automatically when building your application.|
60+
|[GitHub Actions](https://github.com/features/actions)|`<BuildVersioningWithGitHub>`|Will perform a `git fetch` for tags that are missing by default for GitHub Actions. This specific behaviour can be disabled by setting `<GitHubAutoFetchTags>` to false.|
6161
|[Azure DevOps](https://azure.microsoft.com/en-us/services/devops/pipelines/)|`<BuildVersioningWithAzureDevOps>`||
62-
|[AppVeyor](https://www.appveyor.com/)|`<BuildVersioningWithAppVeyor>`||
62+
|[AppVeyor](https://www.appveyor.com/)|`<BuildVersioningWithAppVeyor>`|Will update the AppVeyor build name to match the build version. This specific behaviour can be disabled by setting `<AppVeyorAutoBuildNaming>` to false.|
6363

6464
### Disabling an Integration
6565

src/TurnerSoftware.BuildVersioning/build/TurnerSoftware.BuildVersioning.Integrations.targets

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22

33
<PropertyGroup>
44
<BuildVersioningWithGitHub>true</BuildVersioningWithGitHub>
5+
<GitHubAutoFetchTags>true</GitHubAutoFetchTags>
56
<BuildVersioningWithAppVeyor>true</BuildVersioningWithAppVeyor>
7+
<AppVeyorAutoBuildNaming>true</AppVeyorAutoBuildNaming>
68
<BuildVersioningWithAzureDevOps>true</BuildVersioningWithAzureDevOps>
79
</PropertyGroup>
810

911
<PropertyGroup Condition="$(BuildVersioningWithGitHub) == 'true' AND $(GITHUB_RUN_ID) != ''">
1012
<BuildPreReleaseFormat Condition="$(GITHUB_REF.Split('/')[1]) == 'pull'">pr.$(GITHUB_REF.Split('/')[2])</BuildPreReleaseFormat>
1113
<BuildMetadataFormat>{CommitHash}-github.$(GITHUB_RUN_ID)</BuildMetadataFormat>
1214
</PropertyGroup>
13-
<Target Name="_BuildVersioningWithGitHub" BeforeTargets="BeforeBuild" Condition="$(BuildVersioningWithGitHub) == 'true' AND $(GITHUB_RUN_ID) != ''">
15+
<Target Name="_BuildVersioningWithGitHub_AutoFetchTags" BeforeTargets="BeforeBuild" Condition="$(BuildVersioningWithGitHub) == 'true' AND $(GitHubAutoFetchTags) == 'true' AND $(GITHUB_RUN_ID) != ''">
1416
<Message Importance="$(BuildVersioningLogLevel)" Text="BuildVersioning-GitHubIntegration: Fetching tags for versioning as they aren't available by default in GitHub Actions" />
1517
<Exec Command="git fetch --prune --unshallow --tags --quiet" IgnoreExitCode="true" StandardErrorImportance="low" StandardOutputImportance="low" />
1618
</Target>
@@ -19,7 +21,7 @@
1921
<BuildPreReleaseFormat Condition="$(APPVEYOR_PULL_REQUEST_NUMBER) != ''">pr.$(APPVEYOR_PULL_REQUEST_NUMBER)</BuildPreReleaseFormat>
2022
<BuildMetadataFormat>{CommitHash}-appveyor.$(APPVEYOR_BUILD_ID)</BuildMetadataFormat>
2123
</PropertyGroup>
22-
<Target Name="_BuildVersioningWithAppVeyor" AfterTargets="BuildVersioning" Condition="$(BuildVersioningWithAppVeyor) == 'true' AND $(APPVEYOR) != ''">
24+
<Target Name="_BuildVersioningWithAppVeyor_AutoBuildNaming" AfterTargets="BuildVersioning" Condition="$(BuildVersioningWithAppVeyor) == 'true' AND $(AppVeyorAutoBuildNaming) == 'true' AND $(APPVEYOR) != ''">
2325
<Message Importance="$(BuildVersioningLogLevel)" Text="BuildVersioning-AppVeyorIntegration: Updating AppVeyor build name to $(BuildFullVersion)" />
2426
<Exec Command="powershell Update-AppveyorBuild -Version $(BuildFullVersion)" />
2527
</Target>

0 commit comments

Comments
 (0)