wip: rename arguments

sse-secure-systems · Nov 1, 2024 · 9bd818b · 9bd818b
1 parent 6e8feb4
commit 9bd818b
Show file tree

Hide file tree

Showing 9 changed files with 64 additions and 113 deletions.
diff --git a/.github/actions/grype/action.yaml b/.github/actions/grype/action.yaml
diff --git a/.github/workflows/00_pr.yml b/.github/workflows/00_pr.yml
@@ -31,9 +31,9 @@ jobs:
     #   statuses: read
     #   attestations: read
     secrets: inherit
-    with:
-      run_build: none
-      run_compliance_checks: none
-      run_unit_tests: none
-      run_sast: none
-      run_sca: none
+    # with:
+    #   build: skip
+    #   compliance_checks: skip
+    #   unit_tests: skip
+    #   sast: skip
+    #   sca: skip
diff --git a/.github/workflows/100_ci.yml b/.github/workflows/100_ci.yml
@@ -5,38 +5,38 @@ permissions: {}
 on:
   workflow_call:
     inputs:
-      run_build:
-        description: "Which build jobs should be run: 'all', 'required', 'none'?"
+      build:
+        description: "Which build jobs should be run: 'all', 'only-required', 'skip'?"
         type: string
         default: "all"
         required: false
-      run_compliance_checks:
-        description: "Which compliance checks should be run: 'all', 'required', 'none'?"
+      compliance_checks:
+        description: "Which compliance checks should be run: 'all', 'only-required', 'skip'?"
         type: string
         default: "all"
         required: false
-      run_unit_tests:
-        description: "Which unit tests should be run: 'all', 'required', 'none'?"
+      unit_tests:
+        description: "Which unit tests should be run: 'all', 'only-required', 'skip'?"
         type: string
         default: "all"
         required: false
-      run_sast:
-        description: "Which sast jobs should be run: 'all', 'required', 'none'?"
+      sast:
+        description: "Which sast jobs should be run: 'all', 'only-required', 'skip'?"
         type: string
         default: "all"
         required: false
-      run_sca:
-        description: "Which sca jobs should be run: 'all', 'required', 'none'?"
+      sca:
+        description: "Which sca jobs should be run: 'all', 'only-required', 'skip'?"
         type: string
         default: "all"
         required: false
-      run_docs:
-        description: "Which doc jobs should be run: 'all', 'required', 'none'?"
+      docs:
+        description: "Which doc jobs should be run: 'all', 'only-required', 'skip'?"
         type: string
         default: "all"
         required: false
-      run_integration_tests:
-        description: "Which integration tests should be run: 'all', 'required', 'none'?"
+      integration_tests:
+        description: "Which integration tests should be run: 'all', 'only-required', 'skip'?"
         type: string
         default: "all"
         required: false
@@ -56,20 +56,20 @@ jobs:
     steps:
       - name: Show ci settings
         run: |
-          get_output() { case "$1" in "all") echo ":white_check_mark:";; "required") echo ":information_source:";; "none") echo ":x:";; *) echo "Unknown value";; esac; }
+          get_output() { case "$1" in "all") echo ":white_check_mark:";; "only-required") echo ":information_source:";; "skip") echo ":x:";; *) echo "Unknown value";; esac; }
           echo "# :pencil: CI Settings" >> ${GITHUB_STEP_SUMMARY}
           echo "<table>" >> ${GITHUB_STEP_SUMMARY}
           echo "<tr><th>Setting</th><th>Value</th></tr>" >> ${GITHUB_STEP_SUMMARY}
-          echo "<tr><td>Run Docs</td><td>$(get_output ${{ inputs.run_docs }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
-          echo "<tr><td>Run Build</td><td>$(get_output ${{ inputs.run_build }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
-          echo "<tr><td>Run Compliance</td><td>$(get_output ${{ inputs.run_compliance_checks }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
-          echo "<tr><td>Run Unit Tests</td><td>$(get_output ${{ inputs.run_unit_tests }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
-          echo "<tr><td>Run SAST</td><td>$(get_output ${{ inputs.run_sast }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
-          echo "<tr><td>Run SCA</td><td>$(get_output ${{ inputs.run_sca }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
-          echo "<tr><td>Run Integration Tests</td><td>$(get_output ${{ inputs.run_integration_tests }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
+          echo "<tr><td>Run Docs</td><td>$(get_output ${{ inputs.docs }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
+          echo "<tr><td>Run Build</td><td>$(get_output ${{ inputs.build }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
+          echo "<tr><td>Run Compliance</td><td>$(get_output ${{ inputs.compliance_checks }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
+          echo "<tr><td>Run Unit Tests</td><td>$(get_output ${{ inputs.unit_tests }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
+          echo "<tr><td>Run SAST</td><td>$(get_output ${{ inputs.sast }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
+          echo "<tr><td>Run SCA</td><td>$(get_output ${{ inputs.sca }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
+          echo "<tr><td>Run Integration Tests</td><td>$(get_output ${{ inputs.integration_tests }})</td></tr>" >> ${GITHUB_STEP_SUMMARY}
           echo "<tr><td>Report type</td><td><code>${{ inputs.output_type }}</code></td></tr>" >> ${GITHUB_STEP_SUMMARY}
           echo "</table>" >> ${GITHUB_STEP_SUMMARY}
-          echo "($(get_output 'all') - run all jobs, $(get_output 'required') - run important/required jobs only, $(get_output 'none') - skip jobs)" >> ${GITHUB_STEP_SUMMARY}
+          echo "($(get_output 'all') - run all jobs, $(get_output 'only-required') - run important/required jobs only, $(get_output 'skip') - skip jobs)" >> ${GITHUB_STEP_SUMMARY}
           echo "" >> ${GITHUB_STEP_SUMMARY}
 
   build:
@@ -79,29 +79,29 @@ jobs:
       packages: write
     secrets: inherit
     with:
-      run_build: ${{ inputs.run_build }}
+      jobs_to_run: ${{ inputs.build }}
 
   compliance:
     uses: ./.github/workflows/102_compliance.yml
     needs: [ci-settings]
     permissions:
       contents: read
     with:
-      run_compliance_checks: ${{ inputs.run_compliance_checks }}
+      jobs_to_run: ${{ inputs.compliance_checks }}
 
   unit-test:
     uses: ./.github/workflows/103_unit-test.yml
     needs: [ci-settings]
     with:
-      run_unit_tests: ${{ inputs.run_unit_tests }}
+      jobs_to_run: ${{ inputs.unit_tests }}
 
   sast:
     uses: ./.github/workflows/104_sast.yml
     needs: [ci-settings]
     permissions:
       security-events: write
     with:
-      run_sast: ${{ inputs.run_sast }}
+      jobs_to_run: ${{ inputs.sast }}
       output: ${{ inputs.output_type }}
 
   sca:
@@ -115,7 +115,7 @@ jobs:
       image: ${{ needs.build.outputs.build_image }}
       registry: ${{ needs.build.outputs.build_registry }}
       repo_owner: ${{ github.repository_owner }}
-      run_sca: ${{ inputs.run_sca }}
+      jobs_to_run: ${{ inputs.sca }}
       output: ${{ inputs.output_type }}
 
   docs:
@@ -124,7 +124,7 @@ jobs:
     permissions:
       contents: write
     with:
-      run_docs: ${{ inputs.run_docs }}
+      jobs_to_run: ${{ inputs.docs }}
 
   # integration-test:
   #   uses: ./.github/workflows/integration-test.yml

diff --git a/.github/workflows/101_build.yml b/.github/workflows/101_build.yml
@@ -3,8 +3,8 @@ name: build
 on:
   workflow_call:
     inputs:
-      run_build:
-        description: "Which build jobs should be run: 'all', 'required', 'none'?"
+      jobs_to_run:
+        description: "Which build jobs should be run: 'all', 'only-required', 'skip'?"
         type: string
         default: "all"
     outputs:
@@ -42,7 +42,7 @@ on:
 jobs:
   context:
     runs-on: ubuntu-latest
-    if: inputs.run_build != 'none'
+    if: inputs.jobs_to_run != 'skip'
     permissions: {}
     outputs:
       chart_version: ${{ steps.output_context.outputs.CHART_VERSION }}
@@ -133,7 +133,7 @@ jobs:
 
   build:
     runs-on: ubuntu-latest
-    if: inputs.run_build != 'none'
+    if: inputs.jobs_to_run != 'skip'
     needs: [context]
     permissions:
       packages: write

diff --git a/.github/workflows/102_compliance.yml b/.github/workflows/102_compliance.yml
@@ -3,8 +3,8 @@ name: compliance
 on:
   workflow_call:
     inputs:
-      run_compliance_checks:
-        description: "Which compliance checks should be run: 'all', 'required', 'none'?"
+      jobs_to_run:
+        description: "Which compliance checks should be run: 'all', 'only-required', 'skip'?"
         type: string
         default: "all"
 
@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     if: |
       github.event_name == 'pull_request' &&
-      inputs.run_compliance_checks != 'none'
+      inputs.jobs_to_run != 'skip'
     permissions:
       contents: read
     steps:
@@ -27,7 +27,7 @@ jobs:
     runs-on: ubuntu-latest
     if: |
       github.event_name == 'pull_request' &&
-      inputs.run_compliance_checks != 'none'
+      inputs.jobs_to_run != 'skip'
     permissions: {}
     steps:
       - name: Checkout code

diff --git a/.github/workflows/103_unit-test.yml b/.github/workflows/103_unit-test.yml
@@ -5,16 +5,16 @@ permissions: {}
 on:
   workflow_call:
     inputs:
-      run_unit_tests:
-        description: "Which unit tests should be run: 'all', 'required', 'none'?"
+      jobs_to_run:
+        description: "Which unit tests should be run: 'all', 'only-required', 'skip'?"
         type: string
         default: "all"
 
 jobs:
   gotest:
     name: unit tests
     runs-on: ubuntu-latest
-    if: inputs.run_unit_tests != 'none'
+    if: inputs.jobs_to_run != 'skip'
     steps:
       - name: Checkout code
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

diff --git a/.github/workflows/104_sast.yml b/.github/workflows/104_sast.yml
@@ -3,10 +3,10 @@ name: sast
 on:
   workflow_call:
     inputs:
-      run_sast:
-        description: "Want to skip running certain jobs 'none', 'non-required', 'all'?"
+      jobs_to_run:
+        description: "Which sast jobs should be run: 'all', 'only-required', 'skip'?"
         type: string
-        default: "none"
+        default: "all"
       output:
         description: 'Output either "sarif" (GITHUB_TOKEN with security-events:write) or print results as "table" and fail on error'
         type: string
@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     if: |
       (github.actor != 'dependabot[bot]') &&
-      inputs.run_sast == 'all' &&
+      inputs.jobs_to_run == 'all' &&
       inputs.output == 'sarif'
     permissions:
       security-events: write
@@ -38,7 +38,7 @@ jobs:
     runs-on: ubuntu-latest
     if: |
       (github.actor != 'dependabot[bot]') &&
-      inputs.run_sast != 'none'
+      inputs.jobs_to_run != 'skip'
     permissions:
       security-events: write
     steps:
@@ -58,7 +58,7 @@ jobs:
     runs-on: ubuntu-latest
     if: |
       (github.actor != 'dependabot[bot]') &&
-      inputs.run_sast != 'none'
+      inputs.jobs_to_run != 'skip'
     permissions:
       security-events: write
     steps:
@@ -78,7 +78,7 @@ jobs:
     runs-on: ubuntu-latest
     if: |
       (github.actor != 'dependabot[bot]') &&
-      inputs.run_sast == 'all'
+      inputs.jobs_to_run == 'all'
     permissions:
       security-events: write
     steps:
@@ -101,7 +101,7 @@ jobs:
     runs-on: ubuntu-latest
     if: |
       (github.actor != 'dependabot[bot]') &&
-      inputs.run_sast == 'all'
+      inputs.jobs_to_run == 'all'
     permissions:
       security-events: write
     steps:
@@ -125,7 +125,7 @@ jobs:
     runs-on: ubuntu-latest
     if: |
       (github.actor != 'dependabot[bot]') &&
-      inputs.run_sast == 'all'
+      inputs.jobs_to_run == 'all'
     permissions:
       security-events: write
     steps:

diff --git a/.github/workflows/105_sca.yml b/.github/workflows/105_sca.yml
@@ -19,10 +19,10 @@ on:
         type: string
         required: false
         default: ''
-      run_sca:
-        description: "Want to skip running certain jobs 'none', 'non-required', 'all'?"
+      jobs_to_run:
+        description: "Which sca jobs should be run: 'all', 'only-required', 'skip'?"
         type: string
-        default: "none"
+        default: "all"
       output:
         description: 'Output either "sarif" (GITHUB_TOKEN with security-events:write) or print results as "table" and fail on error'
         type: string
@@ -33,7 +33,7 @@ jobs:
   trivy-image-scan:
     name: trivy image
     runs-on: ubuntu-latest
-    if: inputs.run_sca != 'none'
+    if: inputs.jobs_to_run != 'skip'
     permissions:
       packages: read
       security-events: write