Skip to content

Better Bitbucket support for gitversion /output buildserver for Powershell #3833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 14, 2023
Merged

Better Bitbucket support for gitversion /output buildserver for Powershell #3833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions src/GitVersion.BuildAgents.Tests/Agents/BitBucketPipelinesTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,19 +118,21 @@ public void WriteAllVariablesToTheTextWriter()
{
var assemblyLocation = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
assemblyLocation.ShouldNotBeNull();
var f = PathHelper.Combine(assemblyLocation, "gitversion.properties");
var propertyFile = PathHelper.Combine(assemblyLocation, "gitversion.properties");
var ps1File = PathHelper.Combine(assemblyLocation, "gitversion.ps1");

try
{
AssertVariablesAreWrittenToFile(f);
AssertVariablesAreWrittenToFile(propertyFile, ps1File);
}
finally
{
File.Delete(f);
File.Delete(propertyFile);
File.Delete(ps1File);
}
}

private void AssertVariablesAreWrittenToFile(string file)
private void AssertVariablesAreWrittenToFile(string propertyFile, string ps1File)
{
var writes = new List<string?>();
var semanticVersion = new SemanticVersion
Expand All @@ -147,19 +149,29 @@ private void AssertVariablesAreWrittenToFile(string file)

var variables = variableProvider.GetVariablesFor(semanticVersion, configuration, null);

this.buildServer.WithPropertyFile(file);
this.buildServer.WithPropertyFile(propertyFile);
this.buildServer.WithPowershellFile(ps1File);

this.buildServer.WriteIntegration(writes.Add, variables);

writes[1].ShouldBe("1.2.3-beta.1+5");

File.Exists(file).ShouldBe(true);
File.Exists(propertyFile).ShouldBe(true);

var props = File.ReadAllText(file);
var props = File.ReadAllText(propertyFile);

props.ShouldContain("export GITVERSION_MAJOR=1");
props.ShouldContain("export GITVERSION_MINOR=2");
props.ShouldContain("export GITVERSION_SHA=f28807e615e9f06aec8a33c87780374e0c1f6fb8");
props.ShouldContain("export GITVERSION_COMMITDATE=2022-04-06");

File.Exists(ps1File).ShouldBe(true);

var psProps = File.ReadAllText(ps1File);

psProps.ShouldContain("$GITVERSION_MAJOR = \"1\"");
psProps.ShouldContain("$GITVERSION_MINOR = \"2\"");
psProps.ShouldContain("$GITVERSION_SHA = \"f28807e615e9f06aec8a33c87780374e0c1f6fb8\"");
psProps.ShouldContain("$GITVERSION_COMMITDATE = \"2022-04-06\"");
}
}
37 changes: 29 additions & 8 deletions src/GitVersion.BuildAgents/Agents/BitBucketPipelines.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,37 +9,58 @@ internal class BitBucketPipelines : BuildAgentBase
public const string BranchEnvironmentVariableName = "BITBUCKET_BRANCH";
public const string TagEnvironmentVariableName = "BITBUCKET_TAG";
public const string PullRequestEnvironmentVariableName = "BITBUCKET_PR_ID";
private string? file;
private string? propertyFile;
private string? ps1File;

public BitBucketPipelines(IEnvironment environment, ILog log) : base(environment, log) => WithPropertyFile("gitversion.properties");
public BitBucketPipelines(IEnvironment environment, ILog log) : base(environment, log)
{
WithPropertyFile("gitversion.properties");
WithPowershellFile("gitversion.ps1");
}

protected override string EnvironmentVariable => EnvironmentVariableName;

public override string GenerateSetVersionMessage(GitVersionVariables variables) => variables.FullSemVer;

public void WithPropertyFile(string propertiesFileName) => this.file = propertiesFileName;
public void WithPropertyFile(string propertiesFileName) => this.propertyFile = propertiesFileName;

public void WithPowershellFile(string powershellFileName) => this.ps1File = powershellFileName;

public override string[] GenerateSetParameterMessage(string name, string? value) => new[] { $"GITVERSION_{name.ToUpperInvariant()}={value}" };

public override void WriteIntegration(Action<string?> writer, GitVersionVariables variables, bool updateBuildNumber = true)
{
if (this.file is null)
if (this.propertyFile is null || this.ps1File is null)
return;

base.WriteIntegration(writer, variables, updateBuildNumber);
writer($"Outputting variables to '{this.file}' ... ");
writer($"Outputting variables to '{this.propertyFile}' for Bash,");
writer($"and to '{this.ps1File}' for Powershell ... ");
writer("To import the file into your build environment, add the following line to your build step:");
writer($" - source {this.file}");
writer($"Bash:");
writer($" - source {this.propertyFile}");
writer($"Powershell:");
writer($" - . .\\{this.ps1File}");
writer("");
writer("To reuse the file across build steps, add the file as a build artifact:");
writer($"Bash:");
writer(" artifacts:");
writer($" - {this.propertyFile}");
writer($"Powershell:");
writer(" artifacts:");
writer($" - {this.file}");
writer($" - {this.ps1File}");

var exports = variables
.Select(variable => $"export GITVERSION_{variable.Key.ToUpperInvariant()}={variable.Value}")
.ToList();

File.WriteAllLines(this.file, exports);
File.WriteAllLines(this.propertyFile, exports);

var psExports = variables
.Select(variable => $"$GITVERSION_{variable.Key.ToUpperInvariant()} = \"{variable.Value}\"")
.ToList();

File.WriteAllLines(this.ps1File, psExports);
}

public override string? GetCurrentBranch(bool usingDynamicRepos)
Expand Down