Merge branch 'online-photo-submission-main'

README.md

@@ -121,6 +121,7 @@ The following example showcases a gradle module in the root, without a module na
 | `include-build-environment`  | Optional mode to enable the submission of the `buildEnvironment` as individual Manifest via the dependency submission API. Default: `false`. |
 | `fail-on-error`   | Optional setting to enable an action failure in case any of the dependencies can not be parsed. Default: `false`. |
 | `correlator`  | 'Optional correlator string to submit to GitHub to identify the dependency submission.  Defaults to generating based on gradle-build-module and gradle-build-configuration.' |
+| `legacy-support`  | 'Disabled by default. Optional setting to enable support for gradle versions below 7.5. Warning: When enabled, the action will retrieve all properties and retrieve the property value of interest. During the parsing this may include other properties. Prefer to upgrade to gradle 7.5 or newer instead!' |
 
 | **sub-module-mode**      |    **Description**           |
 | ----- | ---- |

action.yml

@@ -47,6 +47,10 @@ inputs:
     required: false
     description: 'Optional correlator string to submit to GitHub to identify the dependency submission.  Defaults to generating based on gradle-build-module and gradle-build-configuration.'
     default: ''
+  legacy-support:
+    required: false
+    description: 'Enables support for gradle versions below 7.5. Note: If enabled, all properties are read by the action as `--property` was only introduced in Gradle 7.5 or newer.'
+    default: 'false'
 runs:
   using: 'node16'
   main: 'dist/index.js'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gradle-dependency-submission",
-  "version": "0.8.2",
+  "version": "v0.9.0",
   "private": true,
   "description": "Gradle Dependency Submission",
   "main": "lib/main.js",

src/gradle.ts

@@ -14,7 +14,7 @@ export async function singlePropertySupport(useGradlew: boolean, gradleProjectPa
       return true
     } else {
       core.warning(
-        `The current gradle version does not support retrieving a single property. Found version: ${version}. At least required: 7.5.0`
+        `The current gradle version does not support retrieving a single property. Found version: ${version}.`
       )
       return false
     }
@@ -132,19 +132,21 @@ export async function retrieveGradleBuildEnvironment(useGradlew: boolean, gradle
 export async function retrieveGradleBuildPath(
   useGradlew: boolean,
   gradleProjectPath: string,
-  gradleBuildModule: string
+  gradleBuildModule: string,
+  legacySupport: boolean
 ): Promise<string | undefined> {
-  return retrieveGradleProperty(useGradlew, gradleProjectPath, gradleBuildModule, 'buildFile')
+  return retrieveGradleProperty(useGradlew, gradleProjectPath, gradleBuildModule, 'buildFile', legacySupport)
 }
 
 /**
  * Retrieves the `name` `property` from the configured gradle project.
  */
 export async function retrieveGradleProjectName(
   useGradlew: boolean,
-  gradleProjectPath: string
+  gradleProjectPath: string,
+  legacySupport: boolean
 ): Promise<string | undefined> {
-  return retrieveGradleProperty(useGradlew, gradleProjectPath, ':', 'name')
+  return retrieveGradleProperty(useGradlew, gradleProjectPath, ':', 'name', legacySupport)
 }
 
 /**
@@ -154,16 +156,27 @@ async function retrieveGradleProperty(
   useGradlew: boolean,
   gradleProjectPath: string,
   gradleBuildModule: string,
-  property: string
+  property: string,
+  legacySupport: boolean
 ): Promise<string | undefined> {
-  if (!(await singlePropertySupport(useGradlew, gradleProjectPath))) {
-    return undefined
-  }
+  const singlePropertySupported = await singlePropertySupport(useGradlew, gradleProjectPath)
 
   const command = retrieveGradleCLI(useGradlew)
   const module = verifyModule(gradleBuildModule)
 
-  const propertyOutput = await exec.getExecOutput(command, [`${module}:properties`, '-q', '--property', property], {
+  let commandArgs = []
+  if (singlePropertySupported) {
+    commandArgs = [`${module}:properties`, '-q', '--property', property]
+  } else if (legacySupport) {
+    commandArgs = [`${module}:properties`, '-q']
+  } else {
+    core.error(
+      `To enable support for legacy gradle versions without single property support, enable 'legacy-support'. (This will read all properties, read description before proceeding.)`
+    )
+    return undefined
+  }
+
+  const propertyOutput = await exec.getExecOutput(command, commandArgs, {
     cwd: gradleProjectPath,
     silent: !core.isDebug(),
     ignoreReturnCode: true
@@ -175,9 +188,19 @@ async function retrieveGradleProperty(
   }
 
   const output = propertyOutput.stdout
-  const matched = output.match(new RegExp(`[\\S\\s]*?(${property}: )(.+)\n`))
 
-  if (matched != null) {
+  let matched = null
+
+  if (singlePropertySupported) {
+    matched = output.match(new RegExp(`[\\S\\s]*?(${property}: )(.+)\n`))
+  } else {
+    matched = output
+      .split('\n')
+      .map(it => it.match(new RegExp(`[\\S\\s]*?(${property}: )(.+)`)))
+      .find(it => it !== null)
+  }
+
+  if (matched !== null && matched !== undefined) {
     return matched[2]
   }
 

src/main.ts

@@ -16,6 +16,7 @@ async function run(): Promise<void> {
   const includeBuildEnvironment = core.getBooleanInput('include-build-environment')
   const failOnError = core.getBooleanInput('fail-on-error')
   let correlator = core.getInput('correlator')
+  const legacySupport = core.getBooleanInput('legacy-support')
 
   // verify inputs are valid
   if (gradleProjectPath.length === 0) {
@@ -90,7 +91,8 @@ async function run(): Promise<void> {
       gradleDependencyPath.length !== 0 ? gradleDependencyPath[i] : undefined,
       moduleBuildConfigurations,
       subModuleMode,
-      failOnError
+      failOnError,
+      legacySupport
     )
     manifests.push(...subManifests)
   }
@@ -100,7 +102,8 @@ async function run(): Promise<void> {
       useGradlew,
       gradleProjectPath[0],
       undefined,
-      failOnError
+      failOnError,
+      legacySupport
     )
     manifests.push(...buildEnvironmentManifest)
   }
@@ -109,7 +112,7 @@ async function run(): Promise<void> {
     {
       name: 'mikepenz/gradle-dependency-submission',
       url: 'https://github.com/mikepenz/gradle-dependency-submission',
-      version: '0.8.2'
+      version: 'v1.0.1'
     },
     github.context,
     {

src/process.ts

@@ -22,7 +22,8 @@ export async function prepareDependencyManifest(
   gradleDependencyPath: string | undefined,
   moduleBuildConfiguration: Map<string, string>,
   subModuleMode: 'INDIVIDUAL' | 'INDIVIDUAL_DEEP' | 'COMBINED' | 'IGNORE',
-  failOnError: boolean
+  failOnError = false,
+  legacySupport = false
 ): Promise<Manifest[]> {
   const rootProject = await processDependencyList(
     useGradlew,
@@ -40,7 +41,7 @@ export async function prepareDependencyManifest(
   // construct the Manifests
   const manifests: Manifest[] = []
   for (const result of transformProject(rootProject, subModuleMode)) {
-    manifests.push(await buildManifest(result, useGradlew, gradleProjectPath))
+    manifests.push(await buildManifest(result, useGradlew, gradleProjectPath, legacySupport))
   }
   return manifests
 }
@@ -52,7 +53,8 @@ export async function prepareBuildEnvironmentManifest(
   useGradlew: boolean,
   gradleProjectPath: string,
   gradleDependencyPath: string | undefined,
-  failOnError: boolean
+  failOnError: boolean,
+  legacySupport: boolean
 ): Promise<Manifest[]> {
   const rootProject = await processBuildEnvironmentDependencyList(useGradlew, gradleProjectPath, failOnError)
 
@@ -62,7 +64,7 @@ export async function prepareBuildEnvironmentManifest(
   // construct the Manifests
   const manifests: Manifest[] = []
   for (const result of transformProject(rootProject, 'COMBINED')) {
-    manifests.push(await buildManifest(result, useGradlew, gradleProjectPath, 'buildEnvironment'))
+    manifests.push(await buildManifest(result, useGradlew, gradleProjectPath, legacySupport, 'buildEnvironment'))
   }
   return manifests
 }
@@ -145,13 +147,14 @@ async function buildManifest(
   result: Result,
   useGradlew: boolean,
   gradleProjectPath: string,
+  legacySupport: boolean,
   manifestName: string | undefined = undefined
 ): Promise<Manifest> {
   const {project, packageCache, directDependencies, indirectDependencies} = result
 
   let dependencyPath: string
   if (project.dependencyPath === undefined) {
-    const buildPath = await retrieveGradleBuildPath(useGradlew, gradleProjectPath, project.name)
+    const buildPath = await retrieveGradleBuildPath(useGradlew, gradleProjectPath, project.name, legacySupport)
     if (buildPath === undefined) {
       core.setFailed(`🚨 Could not retrieve the gradle dependency path (to the build.gradle) for ${project.name}`)
       throw new Error(`Failed to retrieve gradle build path.`)
@@ -166,7 +169,7 @@ async function buildManifest(
   let name = manifestName || path.dirname(dependencyPath)
   if (name === '.') {
     // if no project name is available, retrieve it from gradle or fallback to `dependencyPath`
-    name = (await retrieveGradleProjectName(useGradlew, gradleProjectPath)) || dependencyPath
+    name = (await retrieveGradleProjectName(useGradlew, gradleProjectPath, legacySupport)) || dependencyPath
   }
   const manifest = new Manifest(name, dependencyPath)
   core.info(`Connection ${directDependencies.length} direct dependencies`)