From 4952023719ed0359d0065e23324c92245cc93375 Mon Sep 17 00:00:00 2001 From: Tomas Matousek Date: Thu, 23 May 2019 16:40:41 -0700 Subject: [PATCH] Update Bitbucket doc --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 76801b5d..d3f36396 100644 --- a/README.md +++ b/README.md @@ -90,9 +90,9 @@ For projects hosted by [GitLab](https://gitlab.com) reference [Microsoft.SourceL ``` -### Bitbucket.org +### Bitbucket -For projects hosted on [Bitbucket.org](https://bitbucket.org) in git repositories reference [Microsoft.SourceLink.Bitbucket.Git](https://www.nuget.org/packages/Microsoft.SourceLink.Bitbucket.Git) package: +For projects in git repositories hosted on [Bitbucket.org](https://bitbucket.org) or hosted on an on-prem Bitbucket server reference [Microsoft.SourceLink.Bitbucket.Git](https://www.nuget.org/packages/Microsoft.SourceLink.Bitbucket.Git) package: ```xml @@ -100,19 +100,17 @@ For projects hosted on [Bitbucket.org](https://bitbucket.org) in git repositorie ``` -For self-hosted Bitbucket projects reference [Microsoft.SourceLink.Bitbucket.Git](https://www.nuget.org/packages/Microsoft.SourceLink.Bitbucket.Git) package and add Bitbucket host configuration. -Additional configuration is available when SourceLinkBitbucketGitHost is added to csproj: - -- EnterpriseEdition - flag whether it is Enterprise Edition or Cloud Edition, by default it is true. -- Version="4.7" - for Enterprise Edition provides its version. URL format for accessing files is different for Bitbucket in version < 4.7, please add Bitbucket version if it is the case +If your project is hosted by Bitbucket Server or Bitbucket Data Center older than version 4.7 you must specify `SourceLinkBitbucketGitHost` item group in addition to the package reference: ```xml - - + ``` +The item group `SourceLinkBitbucketGitHost` specifies the domain of the Bitbucket host and the version of Bitbucket. +The version is important since URL format for accessing files changes with version 4.7. By default SourceLink assumes new format (version 4.7+). + ### Multiple providers, repositories with submodules If your repository contains submodules hosted by other git providers reference packages of all these providers. For example, projects in a repository hosted by Azure DevOps that links a GitHub repository via a submodule should reference both [Microsoft.SourceLink.Vsts.Git](https://www.nuget.org/packages/Microsoft.SourceLink.Vsts.Git) and [Microsoft.SourceLink.GitHub](https://www.nuget.org/packages/Microsoft.SourceLink.GitHub) packages. [Additional configuration](https://github.com/dotnet/sourcelink/blob/master/docs/README.md#configuring-projects-with-multiple-sourcelink-providers) might be needed if multiple Source Link packages are used in the project.