Skip to content

Commit 8028d61

Browse files
authored
Update Readme (#283)
* Update Readme to 1.0.0-beta2-19270-01 * Update Bitbucket doc
1 parent 8144155 commit 8028d61

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

README.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ For projects hosted by [GitHub](http://github.com) or [GitHub Enterprise](https:
5252

5353
```xml
5454
<ItemGroup>
55-
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0-beta2-18618-05" PrivateAssets="All"/>
55+
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0-beta2-19270-01" PrivateAssets="All"/>
5656
</ItemGroup>
5757
```
5858

@@ -62,7 +62,7 @@ For projects hosted by [Azure DevOps](https://www.visualstudio.com/team-services
6262

6363
```xml
6464
<ItemGroup>
65-
<PackageReference Include="Microsoft.SourceLink.Vsts.Git" Version="1.0.0-beta2-18618-05" PrivateAssets="All"/>
65+
<PackageReference Include="Microsoft.SourceLink.Vsts.Git" Version="1.0.0-beta2-19270-01" PrivateAssets="All"/>
6666
</ItemGroup>
6767
```
6868

@@ -73,7 +73,7 @@ For projects hosted by on-prem [Team Foundation Server](https://visualstudio.mic
7373

7474
```xml
7575
<ItemGroup>
76-
<PackageReference Include="Microsoft.SourceLink.Tfs.Git" Version="1.0.0-beta2-18618-05" PrivateAssets="All"/>
76+
<PackageReference Include="Microsoft.SourceLink.Tfs.Git" Version="1.0.0-beta2-19270-01" PrivateAssets="All"/>
7777
<SourceLinkTfsGitHost Include="tfs-server-name" VirtualDirectory="tfs"/>
7878
</ItemGroup>
7979
```
@@ -86,33 +86,31 @@ For projects hosted by [GitLab](https://gitlab.com) reference [Microsoft.SourceL
8686

8787
```xml
8888
<ItemGroup>
89-
<PackageReference Include="Microsoft.SourceLink.GitLab" Version="1.0.0-beta2-18618-05" PrivateAssets="All"/>
89+
<PackageReference Include="Microsoft.SourceLink.GitLab" Version="1.0.0-beta2-19270-01" PrivateAssets="All"/>
9090
</ItemGroup>
9191
```
9292

93-
### Bitbucket.org
93+
### Bitbucket
9494

95-
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:
95+
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:
9696

9797
```xml
9898
<ItemGroup>
99-
<PackageReference Include="Microsoft.SourceLink.Bitbucket.Git" Version="1.0.0-beta2-18618-05" PrivateAssets="All"/>
99+
<PackageReference Include="Microsoft.SourceLink.Bitbucket.Git" Version="1.0.0-beta2-19270-01" PrivateAssets="All"/>
100100
</ItemGroup>
101101
```
102102

103-
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.
104-
Additional configuration is available when SourceLinkBitbucketGitHost is added to csproj:
105-
106-
- EnterpriseEdition - flag whether it is Enterprise Edition or Cloud Edition, by default it is true.
107-
- 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
103+
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:
108104

109105
```xml
110106
<ItemGroup>
111-
<PackageReference Include="Microsoft.SourceLink.Bitbucket.Git" Version="1.0.0-beta2-18618-05" PrivateAssets="All"/>
112-
<SourceLinkBitbucketGitHost Include="bitbucket.yourdomain.com" EnterpriseEdition="true" Version="4.7"/>
107+
<SourceLinkBitbucketGitHost Include="bitbucket.yourdomain.com" Version="4.5"/>
113108
</ItemGroup>
114109
```
115110

111+
The item group `SourceLinkBitbucketGitHost` specifies the domain of the Bitbucket host and the version of Bitbucket.
112+
The version is important since URL format for accessing files changes with version 4.7. By default SourceLink assumes new format (version 4.7+).
113+
116114
### Multiple providers, repositories with submodules
117115

118116
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.
@@ -125,9 +123,9 @@ To add Source Link support to your native project add package references corresp
125123

126124
```xml
127125
<packages>
128-
<package id="Microsoft.Build.Tasks.Git" version="1.0.0-beta2-18618-05" targetFramework="native" developmentDependency="true" />
129-
<package id="Microsoft.SourceLink.Common" version="1.0.0-beta2-18618-05" targetFramework="native" developmentDependency="true" />
130-
<package id="Microsoft.SourceLink.GitHub" version="1.0.0-beta2-18618-05" targetFramework="native" developmentDependency="true" />
126+
<package id="Microsoft.Build.Tasks.Git" version="1.0.0-beta2-19270-01" targetFramework="native" developmentDependency="true" />
127+
<package id="Microsoft.SourceLink.Common" version="1.0.0-beta2-19270-01" targetFramework="native" developmentDependency="true" />
128+
<package id="Microsoft.SourceLink.GitHub" version="1.0.0-beta2-19270-01" targetFramework="native" developmentDependency="true" />
131129
</packages>
132130
```
133131

0 commit comments

Comments
 (0)