From a64f8c6a68e0be93fea279b9081f2e7fe37a3972 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Sat, 12 Oct 2019 08:20:17 +0200 Subject: [PATCH] Update documentation to addin rename (#144) --- ... cake.issues.pullrequests.azuredevops.png} | Bin docs/examples/azure-pipelines.md | 23 ++++---- docs/examples/index.cshtml | 2 +- docs/examples/pullrequest-id.md | 23 ++++---- docs/examples/repository-information.md | 23 ++++---- docs/features.md | 14 ++--- docs/index.cshtml | 8 +-- docs/requirements.md | 6 +- docs/setup.md | 54 +++++++++--------- 9 files changed, 75 insertions(+), 78 deletions(-) rename docs/{cake.issues.pullrequests.tfs.png => cake.issues.pullrequests.azuredevops.png} (100%) diff --git a/docs/cake.issues.pullrequests.tfs.png b/docs/cake.issues.pullrequests.azuredevops.png similarity index 100% rename from docs/cake.issues.pullrequests.tfs.png rename to docs/cake.issues.pullrequests.azuredevops.png diff --git a/docs/examples/azure-pipelines.md b/docs/examples/azure-pipelines.md index 662754b..6078ba5 100644 --- a/docs/examples/azure-pipelines.md +++ b/docs/examples/azure-pipelines.md @@ -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} @@ -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 @@ -68,10 +67,10 @@ Task("ReportIssuesToPullRequest").Does(() => ReportIssuesToPullRequest( InspectCodeIssuesFromFilePath( @"C:\build\inspectcode.log"), - TfsPullRequests( + AzureDevOpsPullRequests( repositoryUrl, pullRequestId, - TfsAuthenticationOAuth(EnvironmentVariable("SYSTEM_ACCESSTOKEN"))), + AzureDevOpsAuthenticationOAuth(EnvironmentVariable("SYSTEM_ACCESSTOKEN"))), repoRootFolder); } } @@ -79,6 +78,6 @@ Task("ReportIssuesToPullRequest").Does(() => }); ``` -[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 diff --git a/docs/examples/index.cshtml b/docs/examples/index.cshtml index 31b5f6c..17e2702 100644 --- a/docs/examples/index.cshtml +++ b/docs/examples/index.cshtml @@ -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. ---

@Html.Raw(Model.String(DocsKeys.Description))

diff --git a/docs/examples/pullrequest-id.md b/docs/examples/pullrequest-id.md index d37eaa3..843390d 100644 --- a/docs/examples/pullrequest-id.md +++ b/docs/examples/pullrequest-id.md @@ -1,10 +1,9 @@ --- 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: @@ -12,16 +11,16 @@ To determine the remote repository URL you need the [Cake.Git] addin: #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} @@ -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(() => @@ -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/ diff --git a/docs/examples/repository-information.md b/docs/examples/repository-information.md index a31c159..804ef7c 100644 --- a/docs/examples/repository-information.md +++ b/docs/examples/repository-information.md @@ -1,10 +1,9 @@ --- 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: @@ -12,16 +11,16 @@ To determine the remote repository URL and source branch of the pull request you #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} @@ -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(() => @@ -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/ diff --git a/docs/features.md b/docs/features.md index b2ff694..b3b4bc2 100644 --- a/docs/features.md +++ b/docs/features.md @@ -1,9 +1,9 @@ --- 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. @@ -11,7 +11,7 @@ There's a [demo repository] available which you can fork and to which you can cr # 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. @@ -19,7 +19,7 @@ There's a [demo repository] available which you can fork and to which you can cr # Supported capabilities -The [Cake.Issues.PullRequests.Tfs addin] supports all [Core features]. +The [Cake.Issues.PullRequests.AzureDevOps addin] supports all [Core features]. | | Capability | Remarks | |--------------------------------------------------------------------|--------------------------------|--------------------------------| @@ -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 | |--------------------------------------------------------------------|--------------------------------------------------------------------|--------------------------------| | | | NTLM | | | | Basic authentication | @@ -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 diff --git a/docs/index.cshtml b/docs/index.cshtml index 4fa97ba..fbf68af 100644 --- a/docs/index.cshtml +++ b/docs/index.cshtml @@ -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. ---

- Support for Team Foundation Server (TFS) and Azure DevOps is implemented in the - Cake.Issues.PullRequests.Tfs addin. + Support for Azure DevOps is implemented in the + Cake.Issues.PullRequests.AzureDevOps addin.

@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/docs/requirements.md b/docs/requirements.md index bfe4a82..9c24511 100644 --- a/docs/requirements.md +++ b/docs/requirements.md @@ -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 diff --git a/docs/setup.md b/docs/setup.md index 17aced5..8d67acd 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,9 +1,9 @@ --- Order: 30 Title: Setup -Description: Instructions how to setup the Cake.Issues.PullRequests.Tfs addin. +Description: Instructions how to setup the Cake.Issues.PullRequests.AzureDevOps addin. --- -This page describes the different ways how the [Cake.Issues.PullRequests.Tfs addin] can be setup. +This page describes the different ways how the [Cake.Issues.PullRequests.AzureDevOps addin] can be setup. # NTLM authentication @@ -11,10 +11,10 @@ This page describes the different ways how the [Cake.Issues.PullRequests.Tfs add NTLM authentication is only available for on-premise Team Foundation Server. ::: -To authenticate with NTLM you can use the [TfsAuthenticationNtlm] alias from the [Cake.Tfs addin]. +To authenticate with NTLM you can use the [AzureDevOpsAuthenticationNtlm] alias from the [Cake.AzureDevOps addin]. The user needs to have `Contribute to pull requests` permission for the specific repository to -allow [Cake.Issues.PullRequests.Tfs addin] to post issues as comments to pull requests. +allow [Cake.Issues.PullRequests.AzureDevOps addin] to post issues as comments to pull requests. # Basic authentication @@ -22,22 +22,22 @@ allow [Cake.Issues.PullRequests.Tfs addin] to post issues as comments to pull re Basic authentication is only available for on-premise Team Foundation Server. ::: -To authenticate with basic authentication you can use the [TfsAuthenticationBasic] alias from the [Cake.Tfs addin] and -need to [Configure TFS to use Basic Authentication]. +To authenticate with basic authentication you can use the [AzureDevOpsAuthenticationBasic] alias from the [Cake.AzureDevOps addin] and +need to [Configure AzureDevOps Server to use Basic Authentication]. The user needs to have `Contribute to pull requests` permission for the specific repository to -allow [Cake.Issues.PullRequests.Tfs addin] to post issues as comments to pull requests. +allow [Cake.Issues.PullRequests.AzureDevOps addin] to post issues as comments to pull requests. # Personal access token -To authenticate with an personal access token you can use the [TfsAuthenticationPersonalAccessToken] alias from the [Cake.Tfs addin]. +To authenticate with an personal access token you can use the [AzureDevOpsAuthenticationPersonalAccessToken] alias from the [Cake.AzureDevOps addin]. -If you want to use the [Cake.Issues.PullRequests.Tfs addin] with an personal access token see -[Authenticate access with personal access tokens for Azure DevOps Services and TFS] for instructions how to create +If you want to use the [Cake.Issues.PullRequests.AzureDevOps addin] with an personal access token see +[Authenticate access with personal access tokens for Azure DevOps] for instructions how to create a personal access token. The access token needs to have the scope `Code (read and write)` set and the user needs to have `Contribute to pull requests` -permission for the specific repository to allow [Cake.Issues.PullRequests.Tfs addin] to post issues as comments to pull requests. +permission for the specific repository to allow [Cake.Issues.PullRequests.AzureDevOps addin] to post issues as comments to pull requests. # OAuth authentication from Azure Pipelines @@ -45,14 +45,14 @@ permission for the specific repository to allow [Cake.Issues.PullRequests.Tfs ad OAuth authentication is only available for Azure DevOps. ::: -If you want to use the [Cake.Issues.PullRequests.Tfs addin] from an Azure Pipelines you can authenticate using the +If you want to use the [Cake.Issues.PullRequests.AzureDevOps addin] from an Azure Pipelines you can authenticate using the OAuth token provided to the build. For this you need to enable the [Allow scripts to access the OAuth token] option on the build definition. -To authenticate you can use the [TfsAuthenticationOAuth] alias from the [Cake.Tfs addin]. +To authenticate you can use the [AzureDevOpsAuthenticationOAuth] alias from the [Cake.AzureDevOps addin]. The user under which the build runs, named ` Build Service ()` (e.g. `Cake.Issues-Demo Build Service (cake-contrib)`), -needs to have `Contribute to pull requests` permission for the specific repository to allow [Cake.Issues.PullRequests.Tfs addin] +needs to have `Contribute to pull requests` permission for the specific repository to allow [Cake.Issues.PullRequests.AzureDevOps addin] to post issues as comments to pull requests. # Azure Active Directory @@ -61,18 +61,18 @@ to post issues as comments to pull requests. OAuth authentication is only available for Azure DevOps. ::: -To authenticate with Azure Active Directory you can use the [TfsAuthenticationAzureActiveDirectory] alias from the [Cake.Tfs addin]. +To authenticate with Azure Active Directory you can use the [AzureDevOpsAuthenticationAzureActiveDirectory] alias from the [Cake.AzureDevOps addin]. The user needs to have `Contribute to pull requests` permission for the specific repository to -allow [Cake.Issues.PullRequests.Tfs addin] to post issues as comments to pull requests. - -[Cake.Issues.PullRequests.Tfs addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.Tfs -[Cake.Tfs addin]: https://www.nuget.org/packages/Cake.Tfs -[Configure TFS to use Basic Authentication]: https://docs.microsoft.com/en-us/azure/devops/integrate/get-started/auth/tfs-basic-auth?view=tfs-2018#configure-tfs-to-use-basic-authentication -[Authenticate access with personal access tokens for Azure DevOps Services and TFS]: https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=vsts -[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 -[TfsAuthenticationNtlm]: https://cakebuild.net/api/Cake.Tfs/TfsAliases/6989592E -[TfsAuthenticationBasic]: https://cakebuild.net/api/Cake.Tfs/TfsAliases/86407B1D -[TfsAuthenticationPersonalAccessToken]: https://cakebuild.net/api/Cake.Tfs/TfsAliases/0E4AC3E3 -[TfsAuthenticationOAuth]: https://cakebuild.net/api/Cake.Tfs/TfsAliases/B5D45B5D -[TfsAuthenticationAzureActiveDirectory]: https://cakebuild.net/api/Cake.Tfs/TfsAliases/0E787800 +allow [Cake.Issues.PullRequests.AzureDevOps addin] to post issues as comments to pull requests. + +[Cake.Issues.PullRequests.AzureDevOps addin]: https://www.nuget.org/packages/Cake.Issues.PullRequests.AzureDevOps +[Cake.AzureDevOps addin]: https://www.nuget.org/packages/Cake.AzureDevOps +[Configure TFS to use Basic Authentication]: https://docs.microsoft.com/en-us/azure/devops/integrate/get-started/auth/tfs-basic-auth#configure-tfs-to-use-basic-authentication +[Authenticate access with personal access tokens for Azure DevOps]: https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate +[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 +[AzureDevOpsAuthenticationNtlm]: https://cakebuild.net/api/Cake.AzureDevOps/AzureDevOpsAliases/F2A040B7 +[AzureDevOpsAuthenticationBasic]: https://cakebuild.net/api/Cake.AzureDevOps/AzureDevOpsAliases/7CD679FF +[AzureDevOpsAuthenticationPersonalAccessToken]: https://cakebuild.net/api/Cake.AzureDevOps/AzureDevOpsAliases/F4DCC101 +[AzureDevOpsAuthenticationOAuth]: https://cakebuild.net/api/Cake.AzureDevOps/AzureDevOpsAliases/988E9C28 +[AzureDevOpsAuthenticationAzureActiveDirectory]: https://cakebuild.net/api/Cake.AzureDevOps/AzureDevOpsAliases/0B9F5DF6