Partial implementation of template parameter & report

.github/workflows/build_and_test.yml

@@ -7,10 +7,11 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
-
+    permissions: read-all
+
     steps:
       - name: Checkout Sources
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install Node.js
         uses: actions/setup-node@v1
@@ -25,5 +26,12 @@ jobs:
 
       - name: Test
         env:
-          GH_TOKEN: ${{ secrets.SECURITY_TOKEN }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: npm test
+
+      - name: Upload results
+        if: always()
+        uses: actions/upload-artifact@v2
+        with:
+          name: results
+          path: _tmp

.github/workflows/build_dist.yml

@@ -0,0 +1,32 @@
+name: Build Distribution
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build-action-dist:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get the current branch name
+        shell: bash
+        run: echo "::set-output name=branch::${GITHUB_REF#refs/heads/}"
+        id: myref
+      - name: Checkout Sources
+        uses: actions/checkout@v3
+
+      - name: Install Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12
+
+      - name: Install Dependencies
+        run: npm ci && npm i -g @vercel/ncc
+
+      - name: Build Executable
+        run: npm run build && ncc build lib --source-map
+
+      - uses: EndBug/add-and-commit@v7
+        with:
+          add: 'dist'
+          message: 'dist release 📦 - created via Actions'
+

.github/workflows/build_executables.yml

@@ -13,10 +13,10 @@ jobs:
           - type: windows-x64
 
     runs-on: ubuntu-latest
-    
+
     steps:
       - name: Checkout Sources
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install Node.js
         uses: actions/setup-node@v1

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '35 6 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

.github/workflows/manual.yml

@@ -6,19 +6,19 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
-    
+
     steps:
-    
+
       - name: Checkout Sources
-        uses: actions/checkout@v2
-          
+        uses: actions/checkout@v3
+
       - name: Invoke Action
         uses: ./
         with:
           token: ${{ secrets.SECURITY_TOKEN }}
           sarifReportDir: ./samples/sarif/peter-murray/advanced-security-java
           outputDir: .
-          
+
       - name: Upload Artifacts
         uses: actions/upload-artifact@v2
         with:

.github/workflows/manual_test_repo.yml

@@ -6,20 +6,20 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
-    
+
     steps:
-    
+
       - name: Checkout Sources
-        uses: actions/checkout@v2
-          
+        uses: actions/checkout@v3
+
       - name: Invoke Action
         uses: ./
         with:
           token: ${{ secrets.TEST_TOKEN }}
           sarifReportDir: ./samples/sarif/java/detailed
           outputDir: .
           repository: octodemo/ghas-reporting
-          
+
       - name: Upload Artifacts
         uses: actions/upload-artifact@v2
         with:

README.md

@@ -27,12 +27,18 @@ saving it in the specified directory.
 * `sarifReportDir`: The directory to look for SARIF reports (from the CodeQL analyze action this defaults to `../results`)
 * `outputDir`: The output directory for the PDF reports, defaults to `github.workspace`
 * `repository`: The repository in `<owner>/<repo_name>` form, defaults to `github.repository`
+* `template`: The report template type used to render the report, defaults to `summary`
 
 
 ## Templates
 
-Currently the templates are hard coded into the action. There are extension points built into the action that will allow
-a future release to provide customization of these templates, via an ability to specify your own.
+Currently there is partial support for templates that are included in the action. Extenders of the action are welcome to author
+additional templates by creating HTML templates using [Nunjucks](https://mozilla.github.io/nunjucks/templating.html) inside the `templates` folder.
+
+You can specify a template by using the `template` parameter. Currently the following templates are available:
+* `summary`: The classic summary report from previous versions.
+* `report`: A more detailed report that includes a list of open alerts broken down by their severity.
+* `report_sca`: A report that includes Software Composition Analysis
 
 
 ## Examples
@@ -67,6 +73,7 @@ Options:
 * `-r`, `--repository`: The repository that contains the source code, in `<owner>/<repository_name>` form, e.g. `peter-murray/node-hue-api`
 * `-s`, `--sarif-directory`: The directory containing the SARIF report files
 * `-o`, `--output-directory`: The directory to output the PDF report to. This will be created if it does not exist.
+* `--template`: The report template type used to render the report. This defaults to `summary`.
 
 An example of running the MacOS command line executable from the un:
 ```
@@ -76,6 +83,6 @@ The above command would output a `summary.pdf` file in the current working direc
 
 ## Future improvements
 
-* Add support for selecting reporting templates to the parameters
+* Additional work on the currently available reports
 * Example of extending html templates and using them
 

action.yml

@@ -21,11 +21,16 @@ inputs:
     description: Repository name with owner. For example, peter-murray/github-security-report
     required: true
     default: ${{ github.repository }}
+
+  template:
+    description: Select the report template type you want to use. For example, `summary` or `report`.
+    required: false
+    default: summary
 
 runs:
-  using: node12
+  using: node16
   main: dist/index.js
 
 branding:
   icon: shield
-  color: green
+  color: green