Isolate 'dependency-submission' action from 'setup-gradle' (#293)

.github/workflows/integ-test-dependency-graph.yml

@@ -21,7 +21,7 @@ env:
   GITHUB_DEPENDENCY_GRAPH_REF: 'refs/tags/v0.0.1' # Use a different ref to avoid updating the real dependency graph for the repository
 
 jobs:
-  groovy-generate:
+  groovy-upload:
     strategy:
       fail-fast: false
       matrix:
@@ -42,7 +42,7 @@ jobs:
       working-directory: .github/workflow-samples/groovy-dsl
 
   groovy-submit:
-    needs: [groovy-generate]
+    needs: [groovy-upload]
     runs-on: "ubuntu-latest"
     steps:
     - name: Checkout sources
@@ -54,6 +54,8 @@ jobs:
       uses: ./setup-gradle
       with:
         dependency-graph: download-and-submit
+      env:
+        DEPENDENCY_GRAPH_DOWNLOAD_ARTIFACT_NAME: groovy-upload
 
   kotlin-generate-and-submit:
     strategy:

.github/workflows/integ-test-dependency-submission.yml

@@ -80,6 +80,8 @@ jobs:
       uses: ./dependency-submission
       with:
         dependency-graph: download-and-submit
+      env:
+        DEPENDENCY_GRAPH_DOWNLOAD_ARTIFACT_NAME: groovy-generate-and-upload-${{ matrix.os }}
 
   kotlin-generate-and-submit:
     strategy:
@@ -225,7 +227,7 @@ jobs:
         gradle-version: ${{ matrix.gradle }}
         build-root-directory: .github/workflow-samples/no-wrapper${{ matrix.build-root-suffix }}
 
-  after-setup-gradle:
+  with-setup-gradle:
     strategy:
       fail-fast: false
       matrix:
@@ -244,6 +246,25 @@ jobs:
       uses: ./dependency-submission
       with:
         build-root-directory: .github/workflow-samples/groovy-dsl
+    - name: Check and delete generated dependency graph
+      shell: bash
+      run: |
+        if [ ! -e "${{ steps.dependency-submission.outputs.dependency-graph-file }}" ]; then
+            echo "Did not find generated dependency graph files"
+            exit 1
+        fi
+        rm ${{ steps.dependency-submission.outputs.dependency-graph-file }}*
+    - name: Run Gradle build
+      run: ./gradlew build
+      working-directory: .github/workflow-samples/groovy-dsl
+    - name: Check no dependency graph is generated
+      shell: bash
+      run: |
+        if [ ! -z "$(ls -A dependency-graph-reports)" ]; then
+            echo "Expected no dependency graph files to be generated"
+            ls -l dependency-graph-reports
+            exit 1
+        fi
 
   custom-report-dir-submit:
     strategy:
@@ -313,6 +334,8 @@ jobs:
         build-root-directory: .github/workflow-samples/groovy-dsl
       env: 
         DEPENDENCY_GRAPH_REPORT_DIR: '${{ github.workspace }}/custom/report-dir'
+        DEPENDENCY_GRAPH_DOWNLOAD_ARTIFACT_NAME: custom-report-dir-upload
+
     - name: Check downloaded dependency graph
       shell: bash
       run: |

sources/src/configuration.ts

@@ -49,6 +49,10 @@ export class DependencyGraphConfig {
         return path.resolve(getWorkspaceDirectory(), 'dependency-graph-reports')
     }
 
+    getDownloadArtifactName(): string | undefined {
+        return process.env['DEPENDENCY_GRAPH_DOWNLOAD_ARTIFACT_NAME']
+    }
+
     static constructJobCorrelator(workflow: string, jobId: string, matrixJson: string): string {
         const matrixString = this.describeMatrix(matrixJson)
         const label = matrixString ? `${workflow}-${jobId}-${matrixString}` : `${workflow}-${jobId}`

sources/src/dependency-graph.ts

@@ -77,7 +77,7 @@ async function downloadAndSubmitDependencyGraphs(config: DependencyGraphConfig):
     }
 
     try {
-        await submitDependencyGraphs(await downloadDependencyGraphs())
+        await submitDependencyGraphs(await downloadDependencyGraphs(config))
     } catch (e) {
         warnOrFail(config, DependencyGraphOption.DownloadAndSubmit, e)
     }
@@ -111,7 +111,7 @@ async function findAndUploadDependencyGraphs(config: DependencyGraphConfig): Pro
     await uploadDependencyGraphs(await findDependencyGraphFiles(), config)
 }
 
-async function downloadDependencyGraphs(): Promise<string[]> {
+async function downloadDependencyGraphs(config: DependencyGraphConfig): Promise<string[]> {
     const findBy = github.context.payload.workflow_run
         ? {
               token: getGithubToken(),
@@ -123,13 +123,19 @@ async function downloadDependencyGraphs(): Promise<string[]> {
 
     const artifactClient = new DefaultArtifactClient()
 
-    const dependencyGraphArtifacts = (
+    let dependencyGraphArtifacts = (
         await artifactClient.listArtifacts({
             latest: true,
             findBy
         })
     ).artifacts.filter(artifact => artifact.name.startsWith(DEPENDENCY_GRAPH_PREFIX))
 
+    const artifactName = config.getDownloadArtifactName()
+    if (artifactName) {
+        core.info(`Filtering for artifacts ending with ${artifactName}`)
+        dependencyGraphArtifacts = dependencyGraphArtifacts.filter(artifact => artifact.name.includes(artifactName))
+    }
+
     for (const artifact of dependencyGraphArtifacts) {
         const downloadedArtifact = await artifactClient.downloadArtifact(artifact.id, {
             findBy

sources/src/dependency-submission/main.ts

@@ -1,3 +1,4 @@
+import * as core from '@actions/core'
 import * as setupGradle from '../setup-gradle'
 import * as gradle from '../execution/gradle'
 import * as dependencyGraph from '../dependency-graph'
@@ -24,6 +25,9 @@ export async function run(): Promise<void> {
         // Configure Gradle environment (Gradle User Home)
         await setupGradle.setup(new CacheConfig(), new BuildScanConfig())
 
+        // Capture the enabled state of dependency-graph
+        const originallyEnabled = process.env['GITHUB_DEPENDENCY_GRAPH_ENABLED']
+
         // Configure the dependency graph submission
         const config = new DependencyGraphConfig()
         await dependencyGraph.setup(config)
@@ -53,6 +57,9 @@ export async function run(): Promise<void> {
 
         await dependencyGraph.complete(config)
 
+        // Reset the enabled state of dependency graph
+        core.exportVariable('GITHUB_DEPENDENCY_GRAPH_ENABLED', originallyEnabled)
+
         saveDeprecationState()
     } catch (error) {
         handleMainActionError(error)