Allow disabling sending PR comments

Call PowerShell entrypoint script directly instead of calling bash first

Author: devblackops

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.1.0] - 2018-01-06
+
+### Changed
+
+- Call PowerShell entrypoint script directly instead of calling bash first.
+- Allow disabling sending PSScriptAnalyzer results back to PR by setting the environment variable `PSSCRIPTANALYZER_SEND_COMMENT` to `false` or `0`.
+
 ## [1.0.1] - 2018-12-28
 
 ### Fixed

README.md

@@ -39,9 +39,10 @@ action "PSScriptAnalyzer" {
 ## Environment Variables
 
 | Name | Default | Description |
-|--------------------------------|---------|-------------|
-| PSSCRIPTANALYZER_ROOT          | . | The root directory to run PSScriptAnalyzer on. By default, this is the root of the repository.
+|--------------------------------|------|-------------|
+| PSSCRIPTANALYZER_ROOT          | .    | The root directory to run PSScriptAnalyzer on. By default, this is the root of the repository.
 | PSSCRIPTANALYZER_SETTINGS_PATH | none | The path to a PSScriptAnalyser settings file to control rules to execute.
+| PSSCRIPTANALYZER_SEND_COMMENT  | true | Enable/disable sending comments with PSScriptAnalyzer results back to PR.
 
 ## Example
 

analyze/Dockerfile

@@ -10,16 +10,15 @@ LABEL "com.github.actions.icon"         = "box"
 LABEL "com.github.actions.color"        = "blue"
 
 LABEL "name"       = "github-action-psscriptanalyzer"
-LABEL "version"    = "1.0.1"
+LABEL "version"    = "1.1.0"
 LABEL "repository" = "https://github.com/devblackops/github-action-psscriptanalyzer"
 LABEL "homepage"   = "https://github.com/PowerShell/PSScriptAnalyzer"
 LABEL "maintainer" = "Brandon Olin <[email protected]>"
 
-ADD entrypoint.sh  /entrypoint.sh
-ADD run.ps1        /run.ps1
+ADD entrypoint.ps1  /entrypoint.ps1
 
 COPY LICENSE README.md /
 
-RUN chmod +x /entrypoint.sh
+RUN chmod +x /entrypoint.ps1
 
-ENTRYPOINT ["/entrypoint.sh"]
+ENTRYPOINT ["pwsh", "/entrypoint.ps1"]

analyze/README.md

@@ -37,6 +37,11 @@ action "PSScriptAnalyzer" {
 ## Environment Variables
 
 | Name | Default | Description |
-|--------------------------------|---------|-------------|
-| PSSCRIPTANALYZER_ROOT          | . | The root directory to run PSScriptAnalyzer on. By default, this is the root of the repository.
+|--------------------------------|------|-------------|
+| PSSCRIPTANALYZER_ROOT          | .    | The root directory to run PSScriptAnalyzer on. By default, this is the root of the repository.
 | PSSCRIPTANALYZER_SETTINGS_PATH | none | The path to a PSScriptAnalyser settings file to control rules to execute.
+| PSSCRIPTANALYZER_SEND_COMMENT  | true | Enable/disable sending comments with PSScriptAnalyzer results back to PR.
+
+## Example
+
+![](media/example.jpg)

analyze/run.ps1 analyze/entrypoint.ps1analyze/run.ps1 renamed to analyze/entrypoint.ps1

@@ -51,19 +51,24 @@ if (($warnings -gt 0) -or ($infos -gt 0)) {
 }
 Write-Output $comment
 
+# Comment threshold
+
+
 # Send comment back to PR if any errors were found
-$ghEvent = Get-Content -Path $env:GITHUB_EVENT_PATH | ConvertFrom-Json
-if ($errors -gt 0) {
-    $params = @{
-        Uri = $ghEvent.pull_request.'_links'.comments.href
-        Method = 'Post'
-        Headers = @{
-            Authorization = "token $env:GITHUB_TOKEN"
+if ($env:PSSCRIPTANALYZER_SEND_COMMENT -ne 'false' -and $env:PSSCRIPTANALYZER_SEND_COMMENT -ne 0) {
+    if ($errors -gt 0) {
+        $ghEvent = Get-Content -Path $env:GITHUB_EVENT_PATH | ConvertFrom-Json
+        $params = @{
+            Uri = $ghEvent.pull_request.'_links'.comments.href
+            Method = 'Post'
+            Headers = @{
+                Authorization = "token $env:GITHUB_TOKEN"
+            }
+            ContentType = 'application/json'
+            Body = @{body = $comment} | ConvertTo-Json
         }
-        ContentType = 'application/json'
-        Body = @{body = $comment} | ConvertTo-Json
+        Invoke-RestMethod @params > $null
     }
-    Invoke-RestMethod @params > $null
 }
 
 exit $errors