output, readme, more (#1)

Author: gdbarron

.github/workflows/test.yml

@@ -2,14 +2,21 @@ name: test
 
 on:
   workflow_dispatch:
+  push:
 
 jobs:
   test-action:
     runs-on: ubuntu-latest
     steps:
       - uses: gdbarron/VenafiPS-action@main
+        id: get-certs
         with:
           token: ${{ secrets.VENAFI_TOKEN }}
-          server: gdb-tpp.se.venafi.com
+          tpp_server: ${{ secrets.VENAFI_SERVER }}
           commands: |
             find-venaficertificate -first 5
+            $action_out = find-venaficertificate -first 5 | ConvertTo-Json -Depth 5 -Compress
+      - name: test output
+        shell: pwsh
+        run: |
+          '${{ steps.get-certs.outputs.action_out}}' | ConvertFrom-Json

Dockerfile

@@ -2,6 +2,6 @@ FROM mcr.microsoft.com/powershell:latest
 
 SHELL ["pwsh"]
 
-COPY /*.ps1 /
+COPY /entrypoint.ps1 /
 
 ENTRYPOINT ["pwsh", "/entrypoint.ps1"]

README.md

@@ -1,6 +1,6 @@
 # VenafiPS GitHub action
 
-Automate Venafi with GitHub actions.
+Automate Venafi with GitHub actions.  Utilizes the [VenafiPS Powershell module](https://github.com/venafi/venafips).
 
 ``` yaml
 name: test
@@ -12,10 +12,12 @@ jobs:
   test-action:
     runs-on: ubuntu-latest
     steps:
-      - uses: gdbarron/VenafiPS-action@main
+      - name: renew certs
+        uses: gdbarron/venafips-action@main
         with:
           token: ${{ secrets.VENAFI_TOKEN }}
-          server: server.company.com
+          server: ${{ secrets.VENAFI_SERVER }}
           commands: |
             Find-VenafiCertificate -First 5 | Invoke-VenafiCertificateAction -Renew
+            $action_out = '' # set this variable to use in another step
 ```

action.yml

@@ -1,16 +1,22 @@
 name: 'VenafiPS'
-description: 'Execute commands from VenafiPS Powershell module'
+description: 'Execute commands from VenafiPS Powershell module, https://github.com/Venafi/VenafiPS'
 author: 'Greg Brownstein'
 inputs:
   token:
     description: TPP token or VaaS key
     required: true
-  server:
+  tpp_server:
     description: TPP server name.  Not required for VaaS.
     required: false
   commands:
     description: Module commands to execute
     required: true
+output:
+  action_out:
+  description: 'Output from action to be used further in the pipeline'
 runs:
   using: 'docker'
   image: 'Dockerfile'
+branding:
+  icon: terminal
+  color: orange

entrypoint.ps1

@@ -1,4 +1,4 @@
-$server = $env:INPUT_SERVER
+$server = $env:INPUT_TPP_SERVER
 $token = $env:INPUT_TOKEN
 
 Set-PSRepository PSGallery -InstallationPolicy Trusted
@@ -18,13 +18,17 @@ if ( [System.Guid]::TryParse($token, [System.Management.Automation.PSReference]$
 else {
 
   Write-Output 'Token is TPP token'
-  
+
   if ( -not $server ) {
     throw "'server' parameter is required when connecting to TPP"
   }
-  
+
   New-VenafiSession -Server $server -AccessToken (New-Object System.Management.Automation.PSCredential('AccessToken', ($token | ConvertTo-SecureString -AsPlainText -Force)))
 }
 
 
 Invoke-Expression $env:INPUT_COMMANDS
+
+if ( $action_out ) {
+  Write-Output "::set-output name=action_out::$action_out"
+}