docs: Enclose System.TeamProject in Azure Pipelines (#2131)

Update the example to enclose System.TeamProject to prevent MegaLinter failing if the Azure DevOps project name contains spaces.
oxsecurity · Dec 18, 2022 · 28035d8 · 28035d8
1 parent b944ba9
commit 28035d8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -508,7 +508,7 @@ Add the following job in your `azure-pipelines.yaml` file
             -e SYSTEM_ACCESSTOKEN=$(System.AccessToken) \
             -e SYSTEM_COLLECTIONURI=$(System.CollectionUri) \
             -e SYSTEM_PULLREQUEST_PULLREQUESTID=$(System.PullRequest.PullRequestId) \
-            -e SYSTEM_TEAMPROJECT=$(System.TeamProject) \
+            -e SYSTEM_TEAMPROJECT="$(System.TeamProject)" \
             -e BUILD_BUILD_ID=$(Build.BuildId) \
             -e BUILD_REPOSITORY_ID=$(Build.Repository.ID) \
             oxsecurity/megalinter:v6

diff --git a/docs/reporters/AzureCommentReporter.md b/docs/reporters/AzureCommentReporter.md
@@ -11,7 +11,7 @@ Click on **MegaLinter-reports** artifact from the main job log to view or downlo
 
 ## Configuration
 
-- The following variables must be sent to docker run command
+- The following variables must be sent to the docker run command
 
 Example:
 
@@ -24,7 +24,7 @@ Example:
             -e SYSTEM_ACCESSTOKEN=$(System.AccessToken) \
             -e SYSTEM_COLLECTIONURI=$(System.CollectionUri) \
             -e SYSTEM_PULLREQUEST_PULLREQUESTID=$(System.PullRequest.PullRequestId) \
-            -e SYSTEM_TEAMPROJECT=$(System.TeamProject) \
+            -e SYSTEM_TEAMPROJECT="$(System.TeamProject)" \
             -e BUILD_BUILD_ID=$(Build.BuildId) \
             -e BUILD_REPOSITORY_ID=$(Build.Repository.ID) \
             oxsecurity/megalinter:v6
@@ -39,7 +39,7 @@ Example:
 
 ![Screenshot](../assets/images/AzureReporterConfigContribute.jpg)
 
-| Variable                          | Description                                                                      | Default value |
-|-----------------------------------|----------------------------------------------------------------------------------|---------------|
-| AZURE_COMMENT_REPORTER            | Activates/deactivates reporter                                                   | true          |
-| AZURE_COMMENT_REPORTER_LINKS_TYPE | Set to `build` if you want comments links to target Build and not artifacts page | `artifacts`   |
+| Variable                          | Description                                                                        | Default value |
+|-----------------------------------|------------------------------------------------------------------------------------|---------------|
+| AZURE_COMMENT_REPORTER            | Activates/deactivates reporter                                                     | true          |
+| AZURE_COMMENT_REPORTER_LINKS_TYPE | Set to `build` if you want comments linking to target Build and not artifacts page | `artifacts`   |