Add ability to turn off colored output (#32)

* Add Action input to control colored Ansible output

* Update main.js

Co-authored-by: Dawid Dziurla <dawidd0811@gmail.com>

.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  pull-request-branch-name:
+    separator: "-"
+  open-pull-requests-limit: 10
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  pull-request-branch-name:
+    separator: "-"
+  open-pull-requests-limit: 10

.github/workflows/test.yml

@@ -113,3 +113,10 @@ jobs:
           directory: test
           vault_password: test
           options: --inventory hosts
+      - name: With sudo
+        uses: ./
+        with:
+          playbook: playbook.yml
+          directory: test
+          sudo: true
+          options: --inventory hosts

README.md

@@ -1,6 +1,6 @@
-# Run Ansible playbook Github Action
+# Run Ansible playbook GitHub Action
 
-An action that executes given Ansible playbook on selected hosts.
+An Action that executes given Ansible playbook on selected hosts.
 
 Should work on any OS, if `ansible-playbook` command is available in `PATH`.
 
@@ -10,17 +10,28 @@ Should work on any OS, if `ansible-playbook` command is available in `PATH`.
 - name: Run playbook
   uses: dawidd6/action-ansible-playbook@v2
   with:
+    # Required, playbook filepath
     playbook: deploy.yml
+    # Optional, directory where playbooks live
     directory: ./
+    # Optional, SSH private key
     key: ${{secrets.SSH_PRIVATE_KEY}}
+    # Optional, literal inventory file contents
     inventory: |
       [all]
       example.com
 
       [group1]
       example.com
+    # Optional, SSH known hosts file content
+    known_hosts: .known_hosts
+    # Optional, encrypted vault password
     vault_password: ${{secrets.VAULT_PASSWORD}}
+    # Optional, galaxy requirements filepath
+    requirements: galaxy-requirements.yml
+    # Optional, additional flags to pass to ansible-playbook
     options: |
+      --inventory .hosts
       --limit group1
       --extra-vars hello=there
       --verbose

action.yml

@@ -28,6 +28,15 @@ inputs:
   options:
     description: Extra options that should be passed to ansible-playbook command
     required: false
+  sudo:
+    description: Set to "true" if root is required for running your playbook
+    required: false
+  no_color:
+    description: Set to "true" if the Ansible output should not include colors (defaults to "false")
+    required: false
+outputs:
+  output:
+    description: The captured output of both stdout and stderr from the Ansible Playbook run
 runs:
   using: node12
   main: main.js

main.js

@@ -14,6 +14,8 @@ async function main() {
         const vaultPassword = core.getInput("vault_password")
         const knownHosts = core.getInput("known_hosts")
         const options = core.getInput("options")
+        const sudo    = core.getInput("sudo")
+        const noColor = core.getInput("no_color")
 
         let cmd = ["ansible-playbook", playbook]
 
@@ -68,23 +70,34 @@ async function main() {
             const knownHostsFile = ".ansible_known_hosts"
             fs.writeFileSync(knownHostsFile, knownHosts, { mode: 0600 })
             core.saveState("knownHostsFile", knownHostsFile)
-            let known_hosts_param = [
+            cmd.push(`--ssh-common-args="-o UserKnownHostsFile=${knownHostsFile}"`)
-                "--ssh-common-args=",
-                "\"",
-                "-o UserKnownHostsFile=",
-                knownHostsFile,
-                "\""
-            ].join('')
-            cmd.push(known_hosts_param)
             process.env.ANSIBLE_HOST_KEY_CHECKING = "True"
         } else {
             process.env.ANSIBLE_HOST_KEY_CHECKING = "False"
         }
 
-        process.env.ANSIBLE_FORCE_COLOR = "True"
+        if (sudo) {
+            cmd.unshift("sudo", "-E", "env", `PATH=${process.env.PATH}`)
+        }
 
-        await exec.exec(cmd.join(' '))
+        if (noColor) {
+            process.env.ANSIBLE_NOCOLOR = "True"
+        } else {
+            process.env.ANSIBLE_FORCE_COLOR = "True"
+        }
 
+        let output = ""
+        await exec.exec(cmd.join(' '), null, {
+          listeners: {
+            stdout: function(data) {
+              output += data.toString()
+            },
+            stderr: function(data) {
+              output += data.toString()
+            }
+          }
+        })
+        core.setOutput("output", output)
     } catch (error) {
         core.setFailed(error.message)
     }

package-lock.json

@@ -5,15 +5,15 @@
   "packages": {
     "": {
       "dependencies": {
-        "@actions/core": "^1.2.6",
+        "@actions/core": "^1.2.7",
         "@actions/exec": "^1.0.4",
         "yaml": "^1.10.2"
       }
     },
     "node_modules/@actions/core": {
-      "version": "1.2.6",
+      "version": "1.2.7",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.6.tgz",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.7.tgz",
-      "integrity": "sha512-ZQYitnqiyBc3D+k7LsgSBmMDVkOVidaagDG7j3fOym77jNunWRuYx7VSHa9GNfFZh+zh61xsCjRj4JxMZlDqTA=="
+      "integrity": "sha512-kzLFD5BgEvq6ubcxdgPbRKGD2Qrgya/5j+wh4LZzqT915I0V3rED+MvjH6NXghbvk1MXknpNNQ3uKjXSEN00Ig=="
     },
     "node_modules/@actions/exec": {
       "version": "1.0.4",
@@ -39,9 +39,9 @@
   },
   "dependencies": {
     "@actions/core": {
-      "version": "1.2.6",
+      "version": "1.2.7",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.6.tgz",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.7.tgz",
-      "integrity": "sha512-ZQYitnqiyBc3D+k7LsgSBmMDVkOVidaagDG7j3fOym77jNunWRuYx7VSHa9GNfFZh+zh61xsCjRj4JxMZlDqTA=="
+      "integrity": "sha512-kzLFD5BgEvq6ubcxdgPbRKGD2Qrgya/5j+wh4LZzqT915I0V3rED+MvjH6NXghbvk1MXknpNNQ3uKjXSEN00Ig=="
     },
     "@actions/exec": {
       "version": "1.0.4",

package.json

@@ -2,7 +2,7 @@
   "name": "action-ansible-playbook",
   "main": "main.js",
   "dependencies": {
-    "@actions/core": "^1.2.6",
+    "@actions/core": "^1.2.7",
     "@actions/exec": "^1.0.4",
     "yaml": "^1.10.2"
   }