Skip to main content

Azure DevOps Bot for Detekt Report

The Azure DevOps Bot for Detekt Report step analyzes your Detekt report and posts the details to an open pull request in Azure DevOps. It also allows you to modify the pull request status.

caution

Danger operates on a similar principle, allowing use of the Danger step with platforms such as GitHub, GitLab, and Bitbucket. However, Danger currently does not support Azure DevOps.

For more information, refer to the Appcircle blog post about Danger:

Prerequisites

The workflow steps that need to be executed before running the Azure DevOps Bot for Detekt Report workflow step, along with their respective reasons, are listed in the table below.

Prerequisite Workflow StepDescription
DetektIn order to generate the Detekt report, the Detekt step must be executed beforehand.

Input Variables

For each step, specific input variables are required for its operation on your system. The input variables necessary for the Azure DevOps Bot for Detekt Report are as follows:

caution

Enter confidential information as secret environment variable and ensure the appropriate environment variable group is selected in the Configuration.

Variable NameDescriptionStatus
$AC_AZURE_ORG_NAMESpecifies the name of the Azure DevOps organization. You can find it in the Azure DevOps URL: https://dev.azure.com/{Your_Organization}. Check out this document to locate the organization name.Required
$AC_AZURE_PROJECT_NAMESpecifies the name of the Azure DevOps project. You can find it in the Azure DevOps URL: https://dev.azure.com/{Your_Organization}/{Your_Project}. For more information about Azure DevOps projects, refer to this document.Required
$AC_AZURE_REPO_NAMESpecifies the name of the Azure DevOps repository. Check out this document for more details about Azure DevOps repositories.Required
$AC_AZURE_BASE_URLSpecifies the base URL of Azure DevOps. The default value is https://dev.azure.com.Required
$AC_AZURE_API_KEYSpecifies the API key for Azure DevOps. Refer to this document for details on how to obtain it.Required
$AC_DETEKT_FILE_PATHSpecifies the file path of the Detekt report. If you used the Detekt step in the previous stage, this section will be automatically filled. The default value is $AC_DETEKT_OUTPUT_PATH, which represents the output of the Detekt step.Required
$AC_DOMAIN_NAMESpecifies the domain name of Appcircle. The default value is my.appcircle.io, which is the domain for Appcircle Cloud.Required
$AC_AZURE_API_VERSIONSpecifies the version of the Azure API, for example: 7.1. Refer to the REST API versioning document for more information.Required

To access the source code of this component, please use the following link:

Preview of GitHub - appcircleio/appcircle-android-azure-bot-for-detekt-component: Bot script that allows Detekt outputs to make changes to Azure DevOps Pull Requests.