Workflow support (#33)

* add support for workflows * use correct workflow argument in command * readme update Co-authored-by: sandeep <[email protected]>
projectdiscovery · Apr 19, 2022 · 69fe4e1 · 69fe4e1
1 parent 8593cd0
commit 69fe4e1
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -66,6 +66,16 @@ jobs:
 
 <ins>As default, all the default [nuclei-templates](https://github.com/projectdiscovery/nuclei-templates) are used for scan.</ins>
 
+**GitHub Action running Nuclei with custom workflows**
+
+```yaml
+      - name: Nuclei - DAST Scan
+        uses: projectdiscovery/nuclei-action@main
+        with:
+          target: https://example.com
+          workflows: custom_workflow_path
+```
+
 **GitHub Action running Nuclei on multiple URLs**
 
 ```yaml
@@ -139,6 +149,7 @@ Available Inputs
 | `target`          | Target URL to run nuclei scan                       | true     |
 | `urls`            | List of urls to run nuclei scan                     | false    |
 | `templates`       | Custom templates directory/file to run nuclei scan  | false    |
+| `workflows`       | Custom workflows file/files to check across hosts   | false    |
 | `output`          | File to save output result (default - nuclei.log)   | false    |
 | `json`            | Write results in JSON format                        | false    |
 | `include-rr`      | Include request/response in results                 | false    |

diff --git a/action.yml b/action.yml
@@ -17,6 +17,10 @@ inputs:
     description: "Templates input file/files to check across hosts"
     required: false
 
+  workflows:
+    description: "Workflows input file/files to check across hosts"
+    required: false
+
   output:
     description: "File to save output result"
     required: false
@@ -78,6 +82,7 @@ runs:
         [ ! -z ${{ inputs.target }} ] && echo "nuclei-target=-target ${{ inputs.target}}" >> $GITHUB_ENV
         [ ! -z ${{ inputs.urls }} ] && echo "nuclei-urls=-list ${{ inputs.urls}}" >> $GITHUB_ENV
         [ ! -z ${{ inputs.templates }} ] && echo "nuclei-templates=-t ${{ inputs.templates }}" >> $GITHUB_ENV
+        [ ! -z ${{ inputs.workflows }} ] && echo "nuclei-workflows=-w ${{ inputs.workflows }}" >> $GITHUB_ENV
         [ ! -z ${{ inputs.output }} ] && echo "nuclei-output=-o ${{ inputs.output}}" >> $GITHUB_ENV || echo "output=-o nuclei.log" >> $GITHUB_ENV
         [ ! -z ${{ inputs.sarif-export }} ] && echo "nuclei-sarif-export=-se ${{ inputs.sarif-export}}" >> $GITHUB_ENV || echo "sarif-export=-se nuclei.sarif" >> $GITHUB_ENV
         [ ! -z ${{ inputs.markdown-export }} ] && echo "nuclei-markdown-export=-me ${{ inputs.markdown-export}}" >> $GITHUB_ENV
@@ -96,15 +101,17 @@ runs:
         && echo -e "  project-name: \"${GITHUB_REPOSITORY#*/}\"" >> ~/nuclei-github-config.yaml \
         && echo -e "  issue-label: \"Nuclei\"" >> ~/nuclei-github-config.yaml \
         && echo "nuclei-githubconfig=-rc ~/nuclei-github-config.yaml" >> $GITHUB_ENV
-        
+
         nuclei -silent
       shell: bash
+
     - run: |
 
         nuclei \
           ${{ env.nuclei-target }} \
           ${{ env.nuclei-urls }} \
           ${{ env.nuclei-templates }} \
+          ${{ env.nuclei-workflows }} \
           ${{ env.nuclei-output }} \
           ${{ env.nuclei-sarif-export }} \
           ${{ env.nuclei-markdown-export }} \