Add build agent for BitBucket Pipelines

[davidkeaveny]

Description

Added a build agent that supports Atlassian's BitBucket Pipelines. It follows a similar pattern to the GitHub Actions build agent, in that it writes out the output from GitVersion to a file which can then be imported into Pipelines.

Related Issue

#3057

Motivation and Context

At present, GitVersion cannot generate version numbers when executed in BitBucket Pipelines on branches that are not develop or main\master (see related issue). By creating a specific build agent, I am hoping to fix this issue.

How Has This Been Tested?

I have created a set of unit tests in the GitVersion.Core.Tests project in the BuildAgents folder.

The build agent can be run from the command line by setting the environment variable BITBUCKET_WORKSPACE to any non-empty value, and BITBUCKET_BRANCH to the branch being built (these values are set automatically by the BitBucket Pipeline).

e.g.

set BITBUCKET_WORKSPACE=MyProject
set BITBUCKET_BRANCH=refs/head/feature/my-new-feature
gitversion.exe /diag

In addition to writing the output to the screen, a file gitversion.env will be created; in BitBucket Pipelines, this file would then be imported to add the new environment variables.

Testing on the build server will require a new NuGet package containing the updated GitVersion.

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

[arturcic]

@davidkeaveny great that you add BitBucket Pipelines support, can you also add a test here https://github.com/GitTools/GitVersion/blob/support/5.x/src/GitVersion.App.Tests/PullRequestInBuildAgentTest.cs

[davidkeaveny]

@arturcic I've added the test to the requested test fixture, and it passes (assuming I'm using it correctly!).

How would I go about doing an end-to-end test? With BitBucket Cloud, build steps run in containers, so I have to install GitVersion as a global tool before running it; I can't just copy a build from my local PC to an on-premise build server.

[arturcic]

@davidkeaveny to have this PR ready to be merged we also need the docs to be updated - can you add a page here as well https://github.com/GitTools/GitVersion/tree/support/5.x/docs/input/docs/reference/build-servers ?

[arturcic]

How would I go about doing an end-to-end test? With BitBucket Cloud, build steps run in containers, so I have to install GitVersion as a global tool before running it; I can't just copy a build from my local PC to an on-premise build server.

When this PR is merged we can prepare a new build as there are already some new code to be released

[davidkeaveny]

I've added initial documentation for using the CLI tool; I haven't documented the use of the Docker image yet because I haven't had a chance to try it out yet.

[asbjornu]

@davidkeaveny, where we would like BitBucket Pipelines support documented is on Build Servers.

[davidkeaveny]

Sorry @gep13 , I can't see what the requested change is.

[gep13]

@davidkeaveny said...
Sorry @gep13 , I can't see what the requested change is.

The requested/suggested changes from me was the slight change to wording in the markdown file, and the removal of the RedirectFrom. Both of these look to have been taken care of.

The remaining item would be the decision between gitversion.env or gitversion.properties. @asbjornu @arturcic what are your thoughts on this?

[arturcic]

@davidkeaveny said...
Sorry @gep13 , I can't see what the requested change is.

The requested/suggested changes from me was the slight change to wording in the markdown file, and the removal of the RedirectFrom. Both of these look to have been taken care of.

The remaining item would be the decision between gitversion.env or gitversion.properties. @asbjornu @arturcic what are your thoughts on this?

I would say gitversion.properties seems fine, and it's already changed to it. I think we can merge it.

[mergify]

Thank you @davidkeaveny for your contribution!

[davidkeaveny]

Is it possible to publish pre-release versions, so that I can test this on my BitBucket Pipelines? If not, is there any particular schedule that GitVersion is working on for a next release?

[arturcic]

There are some PR @asbjornu is working on, so whenever he says he's done we can release.

[github-actions]

🎉 This issue has been resolved in version 5.10.0 🎉
The release is available on:

• GitHub Release
• Chocolatey Package
• .Net Global Tool

Your GitReleaseManager bot 📦🚀