Skip to content

Latest commit

 

History

History
127 lines (85 loc) · 5.59 KB

CONTRIBUTING.md

File metadata and controls

127 lines (85 loc) · 5.59 KB
Raw

Contributing to GitVersion

We love contributions to get started contributing you might need:

Once you know how to create a pull request and have an issue to work on, just post a comment saying you will work on it. If you end up not being able to complete the task, please post another comment so others can pick it up.

Issues are also welcome, failing tests are even more welcome.

Contribution Guidelines

  • Try to use feature branches rather than developing on main.
  • Please include tests covering the change.
  • The documentation is stored in the repository under the docs folder. Have a look at the documentation readme file for guidance on how to improve the documentation and please include documentation updates with your PR.

How it works

See how it works in GitVersion's documentation

Writing Tests

We have made it super easy to write tests in GitVersion. Most tests you are interested in are in GitVersion.Core.Tests\IntegrationTests.

There is a scenario class for each type of branch. For example MainScenarios, FeatureBranchScenarios etc.

1. Find Appropriate Scenario class

Find where your issue would logically sit. Or create a new scenario class if it doesn't fit anywhere in particular.

2. Create a test method

We are currently using NUnit, so just create a descriptive test method and attribute it with [Test]

3. Use a fixture

We have a few fixtures for different scenarios.

  • EmptyRepositoryFixture - Gives you an empty git repo to start with
  • RemoteRepositoryFixture - A local repo tracking a test remote repository. The remote repo is available through the Repository property, the local is accessible via LocalRepository
  • BaseGitFlowRepositoryFixture - A repo setup for GitFlow (has a develop branch checked out ready to go)

You can use a fixture by just using it. Like this

using (var fixture = new EmptyRepositoryFixture(new Config()))
{
}

4. Customize config

If you are using non-default configuration just modify the Config class before creating the fixture

5. Writing the scenario

We have a number of extension method off IRepository to make it easy to write tests at the flow level and not worry about creating/commiting files.

An example test looks like this:

fixture.Repository.MakeATaggedCommit("1.0.0");
fixture.Repository.CreateBranch("feature-test");
fixture.Repository.Checkout("feature-test");
fixture.Repository.MakeACommit();
fixture.Repository.MakeCommits(4);

fixture.AssertFullSemver("1.0.1-test.1+5");

The last line is the most important. AssertFullSemver will run GitVersion and assert that the full SemVer it calculates is what you expect.

6. Submit a pull request with the failing test

Even better include the fix, but a failing test is a great start

Build / Release Process

We use Cake for our build and deployment process. The way the build / release process is setup is:

  1. We build releasable artifacts on AppVeyor
  2. Login to AppVeyor
  3. Deploy the latest main build docs/input/docs/img/release-1-deploy.png
  4. Choose GitVersion release, when you press deploy it will create a non-released GitHub release, this will not create a Git tag. This step is so we can validate the release and release notes before pushing the button. docs/input/docs/img/release-2-deploy.png
  5. All the artifacts should upload nicely docs/input/docs/img/release-3-deploy.png
  6. Head over to GitHub releases, you should have a draft release, download a copy of the release notes docs/input/docs/img/release-4-deploy.png
  7. Edit the release and do the following:
    1. Remove the build metadata from the tag and title (the + and everything after it)
    2. Paste the downloaded release notes in, you can clean them up if you want otherwise there may be closed issues which were questions etc.
    3. Tick the pre-release box if it's pre-release
    4. Press Publish
  8. Publishing tags (a git tag) the release commit, this will trigger another appveyor build which only builds tags, this build uses deploy.cake. It downloads the artifacts from that GitHub release, then performs the release

Docker

It is a manual release step after the release now, first download the appropriate ZIP and put into a releaseArtifacts folder in the GitVersion repository, then run:

docker build . --build-arg GitVersionZip=GitVersion_<VERSION>.zip --tag gittools/gitversion

Code Style

In order to apply the code style defined by by the .editorconfig file you can use dotnet-format.

  1. Install dotnet-format as a global tool:
dotnet tool install -g dotnet-format
  1. Change to the root folder of the GitVersion repository and use the following command to apply the code style:
dotnet format ./ --folder --exclude **/AddFormats/ --fix-codestyle