Build outputs

When changing workflow names or when changing to the new 'dependency-submission'
action, it can be useful to clear existing dependency graph snapshots from previous
submissions. While the old graphs will eventually "age out", the 'clear' option will
submit an empty dependency graph for an existing Job correlator, ensuring that old
dependency graphs don't linger.

.github/workflows/ci-full-check.yml

@@ -9,6 +9,7 @@ on:
   push:
     branches: 
       - main
+      - release/**
     paths:
       - '.github/**'
       - 'dist/**'

.github/workflows/ci-quick-check.yml

@@ -3,7 +3,9 @@ name: CI-quick-check
 on:
   workflow_dispatch:
   push:
-    branches-ignore: main
+    branches-ignore: 
+    - main
+    - release/**
 
 jobs:
   build-distribution:

.github/workflows/ci-verify-outputs.yml

@@ -8,6 +8,7 @@ on:
   push:
     branches: 
       - main
+      - release/**
       - dependabot/**
 
 jobs:

action.yml

@@ -69,7 +69,7 @@ inputs:
     default: true
 
   dependency-graph:
-    description: Specifies if a GitHub dependency snapshot should be generated for each Gradle build, and if so, how. Valid values are 'disabled' (default), 'generate', 'generate-and-submit' and 'download-and-submit'.
+    description: Specifies if a GitHub dependency snapshot should be generated for each Gradle build, and if so, how. Valid values are 'disabled' (default), 'generate', 'generate-and-submit', 'download-and-submit' and 'clear'.
     required: false
     default: 'disabled'
 

actions/clear-dependency-graph/action.yml

@@ -1,24 +0,0 @@
-name: 'Clear dependency graph for a correlator'
-
-inputs:
-  job-correlator:
-    required: true
-
-runs:
-  using: "composite"
-  steps:
-  - name: Set current timestamp as env variable
-    shell: bash
-    run: echo "NOW=$(date -Iseconds)" >> $GITHUB_ENV
-  - name: Submit empty dependency graph
-    shell: bash
-    run: |
-      curl -L \
-      -X POST \
-      -H "Accept: application/vnd.github+json" \
-      -H "Authorization: Bearer ${{ github.token }}" \
-      -H "X-GitHub-Api-Version: 2022-11-28" \
-      https://api.github.com/repos/${{ github.repository }}/dependency-graph/snapshots \
-      -d '{ "version" : 0, "job" : { "id" : "${{ github.run_id }}", "correlator" : "${{ inputs.job-correlator }} " }, "sha" : "${{ github.sha }}", "ref" : "${{ github.ref }}",  "detector" : { "name" : "GitHub Dependency Graph Gradle Plugin", "version" : "0.0.3", "url" : "https://github.com/gradle/github-dependency-graph-gradle-plugin" }, "manifests" : {}, "scanned" : "${{ env.NOW }}" }'
-  - run: echo "::notice ::Cleared dependency graph for job correlator '${{ inputs.job-correlator }}'"
-    shell: bash

dist/main/index.js

@@ -93650,6 +93650,10 @@ function setup(option) {
         core.exportVariable('GITHUB_DEPENDENCY_GRAPH_SHA', getShaFromContext());
         core.exportVariable('GITHUB_DEPENDENCY_GRAPH_WORKSPACE', layout.workspaceDirectory());
         core.exportVariable('DEPENDENCY_GRAPH_REPORT_DIR', path.resolve(layout.workspaceDirectory(), 'dependency-graph-reports'));
+        if (option === input_params_1.DependencyGraphOption.Clear) {
+            core.exportVariable('DEPENDENCY_GRAPH_INCLUDE_PROJECTS', '');
+            core.exportVariable('DEPENDENCY_GRAPH_INCLUDE_CONFIGURATIONS', '');
+        }
     });
 }
 exports.setup = setup;
@@ -93663,6 +93667,7 @@ function complete(option) {
                 yield uploadDependencyGraphs();
                 return;
             case input_params_1.DependencyGraphOption.GenerateAndSubmit:
+            case input_params_1.DependencyGraphOption.Clear:
                 yield submitDependencyGraphs(yield uploadDependencyGraphs());
                 return;
         }
@@ -94077,6 +94082,8 @@ function getDependencyGraphOption() {
             return DependencyGraphOption.GenerateAndSubmit;
         case 'download-and-submit':
             return DependencyGraphOption.DownloadAndSubmit;
+        case 'clear':
+            return DependencyGraphOption.Clear;
     }
     throw TypeError(`The value '${val} is not valid for 'dependency-graph. Valid values are: [disabled, generate-and-upload, generate-and-submit, download-and-submit]. The default value is 'disabled'.`);
 }
@@ -94115,6 +94122,7 @@ var DependencyGraphOption;
     DependencyGraphOption[DependencyGraphOption["Generate"] = 1] = "Generate";
     DependencyGraphOption[DependencyGraphOption["GenerateAndSubmit"] = 2] = "GenerateAndSubmit";
     DependencyGraphOption[DependencyGraphOption["DownloadAndSubmit"] = 3] = "DownloadAndSubmit";
+    DependencyGraphOption[DependencyGraphOption["Clear"] = 4] = "Clear";
 })(DependencyGraphOption || (exports.DependencyGraphOption = DependencyGraphOption = {}));
 
 

dist/post/index.js

@@ -93650,6 +93650,10 @@ function setup(option) {
         core.exportVariable('GITHUB_DEPENDENCY_GRAPH_SHA', getShaFromContext());
         core.exportVariable('GITHUB_DEPENDENCY_GRAPH_WORKSPACE', layout.workspaceDirectory());
         core.exportVariable('DEPENDENCY_GRAPH_REPORT_DIR', path.resolve(layout.workspaceDirectory(), 'dependency-graph-reports'));
+        if (option === input_params_1.DependencyGraphOption.Clear) {
+            core.exportVariable('DEPENDENCY_GRAPH_INCLUDE_PROJECTS', '');
+            core.exportVariable('DEPENDENCY_GRAPH_INCLUDE_CONFIGURATIONS', '');
+        }
     });
 }
 exports.setup = setup;
@@ -93663,6 +93667,7 @@ function complete(option) {
                 yield uploadDependencyGraphs();
                 return;
             case input_params_1.DependencyGraphOption.GenerateAndSubmit:
+            case input_params_1.DependencyGraphOption.Clear:
                 yield submitDependencyGraphs(yield uploadDependencyGraphs());
                 return;
         }
@@ -93945,6 +93950,8 @@ function getDependencyGraphOption() {
             return DependencyGraphOption.GenerateAndSubmit;
         case 'download-and-submit':
             return DependencyGraphOption.DownloadAndSubmit;
+        case 'clear':
+            return DependencyGraphOption.Clear;
     }
     throw TypeError(`The value '${val} is not valid for 'dependency-graph. Valid values are: [disabled, generate-and-upload, generate-and-submit, download-and-submit]. The default value is 'disabled'.`);
 }
@@ -93983,6 +93990,7 @@ var DependencyGraphOption;
     DependencyGraphOption[DependencyGraphOption["Generate"] = 1] = "Generate";
     DependencyGraphOption[DependencyGraphOption["GenerateAndSubmit"] = 2] = "GenerateAndSubmit";
     DependencyGraphOption[DependencyGraphOption["DownloadAndSubmit"] = 3] = "DownloadAndSubmit";
+    DependencyGraphOption[DependencyGraphOption["Clear"] = 4] = "Clear";
 })(DependencyGraphOption || (exports.DependencyGraphOption = DependencyGraphOption = {}));
 
 

src/dependency-graph.ts

@@ -36,6 +36,12 @@ export async function setup(option: DependencyGraphOption): Promise<void> {
         'DEPENDENCY_GRAPH_REPORT_DIR',
         path.resolve(layout.workspaceDirectory(), 'dependency-graph-reports')
     )
+
+    // To clear the dependency graph, we generate an empty graph by excluding all projects and configurations
+    if (option === DependencyGraphOption.Clear) {
+        core.exportVariable('DEPENDENCY_GRAPH_INCLUDE_PROJECTS', '')
+        core.exportVariable('DEPENDENCY_GRAPH_INCLUDE_CONFIGURATIONS', '')
+    }
 }
 
 export async function complete(option: DependencyGraphOption): Promise<void> {
@@ -47,6 +53,7 @@ export async function complete(option: DependencyGraphOption): Promise<void> {
             await uploadDependencyGraphs()
             return
         case DependencyGraphOption.GenerateAndSubmit:
+        case DependencyGraphOption.Clear: // Submit the empty dependency graph
             await submitDependencyGraphs(await uploadDependencyGraphs())
             return
     }

src/input-params.ts

@@ -82,6 +82,8 @@ export function getDependencyGraphOption(): DependencyGraphOption {
             return DependencyGraphOption.GenerateAndSubmit
         case 'download-and-submit':
             return DependencyGraphOption.DownloadAndSubmit
+        case 'clear':
+            return DependencyGraphOption.Clear
     }
     throw TypeError(
         `The value '${val} is not valid for 'dependency-graph. Valid values are: [disabled, generate-and-upload, generate-and-submit, download-and-submit]. The default value is 'disabled'.`
@@ -122,5 +124,6 @@ export enum DependencyGraphOption {
     Disabled,
     Generate,
     GenerateAndSubmit,
-    DownloadAndSubmit
+    DownloadAndSubmit,
+    Clear
 }