Skip to content
This repository has been archived by the owner on Apr 6, 2024. It is now read-only.

Commit

Permalink
Update documentation to addin rename (#144)
Browse files Browse the repository at this point in the history
  • Loading branch information
pascalberger authored Oct 12, 2019
1 parent fa39d74 commit a64f8c6
Show file tree
Hide file tree
Showing 9 changed files with 75 additions and 78 deletions.
23 changes: 11 additions & 12 deletions docs/examples/azure-pipelines.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
---
Order: 30
Title: Using with Azure Pipelines
Description: Example how to use the Cake.Issues.PullRequests.Tfs addin from an Azure Pipelines build.
Description: Example how to use the Cake.Issues.PullRequests.AzureDevOps addin from an Azure Pipelines build.
---
This example shows how to write issues as comments to a Team Foundation Server (TFS) or
Azure DevOps pull request from an Azure Pipelines build.
This example shows how to write issues as comments to an Azure DevOps pull request from an Azure Pipelines build.

To write issues as comments to TFS or Azure DevOps pull requests you need to import the core addin,
the core pull request addin, the TFS/Azure DevOps support including the Cake TFS addin, and one or more issue providers,
To write issues as comments to Azure DevOps pull requests you need to import the core addin,
the core pull request addin, the Azure DevOps support including the Cake.AzureDevOps addin, and one or more issue providers,
in this example for JetBrains InspectCode:

```csharp
#addin "Cake.Issues"
#addin "Cake.Issues.InspectCode"
#addin "Cake.Issues.PullRequests"
#addin "Cake.Issues.PullRequests.Tfs"
#addin "Cake.Tfs"
#addin "Cake.Issues.PullRequests.AzureDevOps"
#addin "Cake.AzureDevOps"
```

:::{.alert .alert-warning}
Expand All @@ -27,7 +26,7 @@ See [pinning addin versions](https://cakebuild.net/docs/tutorials/pinning-cake-v

In the following task we'll first determine if the build is running on Azure DevOps and for a pull request,
then read the remote repository URL and pull request id from environment variables set by the Azure Pipelines build
and finally call the [TfsPullRequests] alias using the OAuth token provided by the Azure Pipeline build.
and finally call the [AzureDevOpsPullRequests] alias using the OAuth token provided by the Azure Pipeline build.

:::{.alert .alert-info}
Please note that you'll need to setup your Azure Pipelines build to allow scripts to
Expand Down Expand Up @@ -68,17 +67,17 @@ Task("ReportIssuesToPullRequest").Does(() =>
ReportIssuesToPullRequest(
InspectCodeIssuesFromFilePath(
@"C:\build\inspectcode.log"),
TfsPullRequests(
AzureDevOpsPullRequests(
repositoryUrl,
pullRequestId,
TfsAuthenticationOAuth(EnvironmentVariable("SYSTEM_ACCESSTOKEN"))),
AzureDevOpsAuthenticationOAuth(EnvironmentVariable("SYSTEM_ACCESSTOKEN"))),
repoRootFolder);
}
}
}
});
```

[TfsPullRequests]: ../../../../api/Cake.Issues.PullRequests.Tfs/TfsPullRequestSystemAliases/BC3F9B2C
[Allow scripts to access the OAuth token]: https://docs.microsoft.com/en-us/azure/devops/pipelines/build/options?view=vsts&tabs=yaml#allow-scripts-to-access-the-oauth-token
[AzureDevOpsPullRequests]: ../../../../api/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases/64912B0A
[Allow scripts to access the OAuth token]: https://docs.microsoft.com/en-us/azure/devops/pipelines/build/options#allow-scripts-to-access-the-oauth-token
[OAuth authentication from Azure Pipelines]: ../setup#oauth-authentication-from-azure-pipelines
2 changes: 1 addition & 1 deletion docs/examples/index.cshtml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
Title: Examples
Description: Examples for using the Cake.Issues.PullRequests.Tfs addin.
Description: Examples for using the Cake.Issues.PullRequests.AzureDevOps addin.
---
<p>@Html.Raw(Model.String(DocsKeys.Description))</p>

Expand Down
23 changes: 11 additions & 12 deletions docs/examples/pullrequest-id.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
---
Order: 10
Title: Using with pull request id
Description: Example how to use the Cake.Issues.PullRequests.Tfs addin with pull request id.
Description: Example how to use the Cake.Issues.PullRequests.AzureDevOps addin with pull request id.
---
This example shows how to write issues as comments to a Team Foundation Server (TFS) or
Azure DevOps pull request while using pull request id.
This example shows how to write issues as comments to an Azure DevOps pull request while using pull request id.

To determine the remote repository URL you need the [Cake.Git] addin:

```csharp
#addin "Cake.Git"
```

To write issues as comments to TFS or Azure DevOps pull requests you need to import the core addin,
the core pull request addin, the TFS/Azure DevOps support including the Cake TFS addin, and one or more issue providers,
To write issues as comments to Azure DevOps pull requests you need to import the core addin,
the core pull request addin, the Azure DevOps support including the Cake.AzureDevOps addin, and one or more issue providers,
in this example for JetBrains InspectCode:

```csharp
#addin "Cake.Issues"
#addin "Cake.Issues.InspectCode"
#addin "Cake.Issues.PullRequests"
#addin "Cake.Issues.PullRequests.Tfs"
#addin "Cake.Tfs"
#addin "Cake.Issues.PullRequests.AzureDevOps"
#addin "Cake.AzureDevOps"
```

:::{.alert .alert-warning}
Expand All @@ -32,8 +31,8 @@ See [pinning addin versions](https://cakebuild.net/docs/tutorials/pinning-cake-v
:::

In the following task we'll first determine the remote repository URL and
with this information call the [TfsPullRequests] alias,
which will authenticate through NTLM to a on-premise TFS instance:
with this information call the [AzureDevOpsPullRequests] alias,
which will authenticate through NTLM to an on-premise Azure DevOps Server instance:

```csharp
Task("ReportIssuesToPullRequest").Does(() =>
Expand All @@ -45,13 +44,13 @@ Task("ReportIssuesToPullRequest").Does(() =>
ReportIssuesToPullRequest(
InspectCodeIssuesFromFilePath(
@"C:\build\inspectcode.log"),
TfsPullRequests(
AzureDevOpsPullRequests(
repoRemoteUrl,
pullRequestId,
TfsAuthenticationNtlm()),
AzureDevOpsAuthenticationNtlm()),
repoRootFolder);
});
```

[TfsPullRequests]: ../../../../api/Cake.Issues.PullRequests.Tfs/TfsPullRequestSystemAliases/BC3F9B2C
[AzureDevOpsPullRequests]: ../../../../api/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases/64912B0A
[Cake.Git]: https://www.nuget.org/packages/Cake.Git/
23 changes: 11 additions & 12 deletions docs/examples/repository-information.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
---
Order: 20
Title: Using with repository remote url and source branch name
Description: Example how to use the Cake.Issues.PullRequests.Tfs addin with repository remote url and source branch name.
Description: Example how to use the Cake.Issues.PullRequests.AzureDevOps addin with repository remote url and source branch name.
---
This example shows how to write issues as comments to a Team Foundation Server (TFS) or
Azure DevOps pull request while using repository information.
This example shows how to write issues as comments to an Azure DevOps pull request while using repository information.

To determine the remote repository URL and source branch of the pull request you need the [Cake.Git] addin:

```csharp
#addin "Cake.Git"
```

To write issues as comments to TFS or Azure DevOps pull requests you need to import the core addin,
the core pull request addin, the TFS/Azure DevOps support including the Cake TFS addin, and one or more issue providers,
To write issues as comments to Azure DevOps pull requests you need to import the core addin,
the core pull request addin, the Azure DevOps support including the Cake.AzureDevOps addin, and one or more issue providers,
in this example for JetBrains InspectCode:

```csharp
#addin "Cake.Issues"
#addin "Cake.Issues.InspectCode"
#addin "Cake.Issues.PullRequests"
#addin "Cake.Issues.PullRequests.Tfs"
#addin "Cake.Tfs"
#addin "Cake.Issues.PullRequests.AzureDevOps"
#addin "Cake.AzureDevOps"
```

:::{.alert .alert-warning}
Expand All @@ -32,8 +31,8 @@ See [pinning addin versions](https://cakebuild.net/docs/tutorials/pinning-cake-v
:::

In the following task we'll first determine the remote repository URL and
source branch of the pull request and with this information call the [TfsPullRequests] alias,
which will authenticate through NTLM to a on-premise TFS instance:
source branch of the pull request and with this information call the [AzureDevOpsPullRequests] alias,
which will authenticate through NTLM to an on-premise Azure DevOps Server instance:

```csharp
Task("ReportIssuesToPullRequest").Does(() =>
Expand All @@ -46,13 +45,13 @@ Task("ReportIssuesToPullRequest").Does(() =>
ReportIssuesToPullRequest(
InspectCodeIssuesFromFilePath(
@"C:\build\inspectcode.log"),
TfsPullRequests(
AzureDevOpsPullRequests(
repoRemoteUrl,
sourceBranchName,
TfsAuthenticationNtlm()),
AzureDevOpsAuthenticationNtlm()),
repoRootFolder);
});
```

[TfsPullRequests]: ../../../../api/Cake.Issues.PullRequests.Tfs/TfsPullRequestSystemAliases/8B150084
[AzureDevOpsPullRequests]: ../../../../api/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases/8D75BECA
[Cake.Git]: https://www.nuget.org/packages/Cake.Git/
14 changes: 7 additions & 7 deletions docs/features.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
---
Order: 20
Title: Features
Description: Features of the Cake.Issues.PullRequests.Tfs addin.
Description: Features of the Cake.Issues.PullRequests.AzureDevOps addin.
---
The [Cake.Issues.PullRequests.Tfs addin] provides the following features.
The [Cake.Issues.PullRequests.AzureDevOps addin] provides the following features.

:::{.alert .alert-info}
There's a [demo repository] available which you can fork and to which you can create pull requests to test the integration functionality.
:::

# Basic features

* Writes issues as comments to Team Foundation Server (TFS) or [Azure DevOps] pull requests.
* Writes issues as comments to [Azure DevOps] pull requests.
* Identification of pull requests through source branch or pull request ID.
* Comments written by the addin will be rendered with a specific icon corresponding to the state of the issue.
* Adds rule number and, if provided by the issue provider, link to the rule description to the comment.
* Support for issues messages formatted in Markdown format.

# Supported capabilities

The [Cake.Issues.PullRequests.Tfs addin] supports all [Core features].
The [Cake.Issues.PullRequests.AzureDevOps addin] supports all [Core features].

| | Capability | Remarks |
|--------------------------------------------------------------------|--------------------------------|--------------------------------|
Expand All @@ -29,7 +29,7 @@ The [Cake.Issues.PullRequests.Tfs addin] supports all [Core features].

# Supported authentication methods

| On-Premise Team Foundation Server | Azure DevOps | Authentication method |
| Azure DevOps Server | Azure DevOps Service | Authentication method |
|--------------------------------------------------------------------|--------------------------------------------------------------------|--------------------------------|
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | <span class="glyphicon glyphicon-remove" style="color:red"></span> | NTLM |
| <span class="glyphicon glyphicon-ok" style="color:green"></span> | <span class="glyphicon glyphicon-remove" style="color:red"></span> | Basic authentication |
Expand All @@ -39,10 +39,10 @@ The [Cake.Issues.PullRequests.Tfs addin] supports all [Core features].

For detailed instructions how to connect using the different methods see [Setup instructions].

![Cake.Issues.PullRequests.Tfs](cake.issues.pullrequests.tfs.png "Cake.Issues.PullRequests.Tfs")
![Cake.Issues.PullRequests.AzureDevOps](cake.issues.pullrequests.azuredevops.png "Cake.Issues.PullRequests.AzureDevOps")

[demo repository]: https://dev.azure.com/pberger/Cake.Issues-Demo
[Cake.Issues.PullRequests.Tfs addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.Tfs
[Cake.Issues.PullRequests.AzureDevOps addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.AzureDevOps
[Azure DevOps]: https://azure.microsoft.com/en-us/services/devops/
[Core features]: ../../overview/features#supported-core-functionality
[Setup instructions]: setup
8 changes: 4 additions & 4 deletions docs/index.cshtml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
Title: TFS & Azure DevOps
Description: Support for Team Foundation Server and Azure DevOps.
Title: Azure DevOps
Description: Support for Azure DevOps.
---
<p>
Support for Team Foundation Server (TFS) and Azure DevOps is implemented in the
<a href="https://www.nuget.org/packages/Cake.Issues.PullRequests.Tfs" target="_blank">Cake.Issues.PullRequests.Tfs addin</a>.
Support for Azure DevOps is implemented in the
<a href="https://www.nuget.org/packages/Cake.Issues.PullRequests.AzureDevOps" target="_blank">Cake.Issues.PullRequests.AzureDevOps addin</a>.
</p>

@Html.Partial("_ChildPages")
6 changes: 3 additions & 3 deletions docs/requirements.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
Order: 10
Title: Requirements
Description: Requirements for the Cake.Issues.PullRequests.Tfs addin.
Description: Requirements for the Cake.Issues.PullRequests.AzureDevOps addin.
---
The requirements for using the [Cake.Issues.PullRequests.Tfs addin] are listed in the [release notes] for any specific version.
The requirements for using the [Cake.Issues.PullRequests.AzureDevOps addin] are listed in the [release notes] for any specific version.

[Cake.Issues.PullRequests.Tfs addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.Tfs
[Cake.Issues.PullRequests.AzureDevOps addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.AzureDevOps
[release notes]: release-notes
Loading

0 comments on commit a64f8c6

Please sign in to comment.