Merge pull request #59 from eskatos/dd/v1-improved

Minor cleanups, simplifications and improvements

.github/workflows/prod.yml

@@ -6,7 +6,7 @@ on:
   push:
 
 jobs:
-  check:
+  gradle-execution:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
@@ -22,12 +22,6 @@ jobs:
       with:
         build-root-directory: __tests__/samples/basic
         arguments: test
-    - name: Test custom wrapper location
-      uses: ./
-      with:
-        build-root-directory: __tests__/samples/no-wrapper
-        wrapper-directory: __tests__/samples/basic
-        arguments: help
     - name: Test use defined Gradle version
       uses: ./
       with:
@@ -37,7 +31,7 @@ jobs:
     - name: Test use Gradle version alias
       uses: ./
       with:
-        gradle-version: rc
+        gradle-version: release-candidate
         build-root-directory: __tests__/samples/no-wrapper
         arguments: help
     - name: Test use defined Gradle executable
@@ -46,6 +40,45 @@ jobs:
         gradle-executable: __tests__/samples/basic/gradlew${{ matrix.script-suffix }}
         build-root-directory: __tests__/samples/no-wrapper
         arguments: help
+    - name: Test custom wrapper location (deprecated)
+      uses: ./
+      with:
+        build-root-directory: __tests__/samples/no-wrapper
+        wrapper-directory: __tests__/samples/basic
+        arguments: help
+
+  dependencies-cache:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout sources
+      uses: actions/checkout@v2
+    - name: Test dependencies-cache-enabled
+      uses: ./
+      with:
+        build-root-directory: __tests__/samples/basic
+        arguments: test --no-daemon
+        dependencies-cache-enabled: true
+
+  configuration-cache:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout sources
+      uses: actions/checkout@v2
+    - name: Test configuration-cache-enabled
+      uses: ./
+      with:
+        build-root-directory: __tests__/samples/basic
+        arguments: test --configuration-cache --no-daemon
+        configuration-cache-enabled: true
+        dependencies-cache-enabled: true 
+        # Configuration cache requires dependencies cache, since it assumes dependencies are already downloaded.
+
 
   failures: # These build invocations are informational only, and are expected to fail
     runs-on: ubuntu-latest

README.md

@@ -60,14 +60,6 @@ If you need to pass environment variables, simply use the GitHub Actions workflo
     build-root-directory: some/subdirectory
 ```
 
-## Use a Gradle wrapper from a different directory
- 
-```yaml
- - uses: eskatos/gradle-command-action@v1
-   with:
-     wrapper-directory: path/to/wrapper-directory
- ```
-
 ## Use a specific `gradle` executable
 
 ```yaml
@@ -76,6 +68,16 @@ If you need to pass environment variables, simply use the GitHub Actions workflo
      gradle-executable: path/to/gradle
 ```
 
+## Use a Gradle wrapper from a different directory
+ 
+```yaml
+ - uses: eskatos/gradle-command-action@v1
+   with:
+     gradle-executable: path/to/gradlew
+ ```
+
+ NOTE: The `wrapper-directory` input has been deprecated. Use `gradle-executable` instead.
+
 ## Setup and use a declared Gradle version
 
 ```yaml
@@ -90,11 +92,11 @@ Moreover, you can use the following aliases:
 
 | Alias | Selects |
 | --- |---|
-| `wrapper`      | The Gradle wrapper's version (default, useful for matrix builds) |
-| `current`      | The current [stable release](https://gradle.org/install/) |
-| `rc`      | The current [release candidate](https://gradle.org/release-candidate/) if any, otherwise fallback to `current` |
-| `nightly` | The latest [nightly](https://gradle.org/nightly/), fails if none. |
-| `release-nightly` | The latest [release nightly](https://gradle.org/release-nightly/), fails if none.      |
+| `wrapper`           | The Gradle wrapper's version (default, useful for matrix builds) |
+| `current`           | The current [stable release](https://gradle.org/install/) |
+| `release-candidate` | The current [release candidate](https://gradle.org/release-candidate/) if any, otherwise fallback to `current` |
+| `nightly`           | The latest [nightly](https://gradle.org/nightly/), fails if none. |
+| `release-nightly`   | The latest [release nightly](https://gradle.org/release-nightly/), fails if none.      |
 
 This can be handy to, for example, automatically test your build with the next Gradle version once a release candidate is out:
 
@@ -114,7 +116,7 @@ jobs:
         java-version: 11
     - uses: eskatos/gradle-command-action@v1
       with:
-        gradle-version: rc
+        gradle-version: release-candidate
         arguments: build --dry-run # just test build configuration
 ```
 

action.yml

@@ -8,6 +8,7 @@ inputs:
   wrapper-directory:
     description: Path to the Gradle Wrapper directory
     required: false
+    deprecationMessage: Use 'gradle-executable' to point to a gradlew[.bat] file in a non-default location
   gradle-executable:
     description: Path to the Gradle executable
     required: false
@@ -23,28 +24,34 @@ inputs:
   distributions-cache-enabled:
     description: Whether caching downloaded Gradle distributions is enabled or not, default to 'true'
     required: false
+    default: true
   wrapper-cache-enabled:
     description: Whether caching wrapper installation is enabled or not, default to 'true'
     required: false
+    default: true
     deprecationMessage: Replaced by 'distributions-cache-enabled' which enables caching for all downloaded Gradle distributions
   dependencies-cache-enabled:
     description: Whether caching dependencies is enabled or not, default to 'false'
     required: false
+    default: false
   dependencies-cache-key:
     description: Globs of files to hash in the build root directory, separated by new lines, use best-effort if unset
     required: false
   dependencies-cache-exact:
     description: Whether to restore only if exact match, default to 'false'
     required: false
+    default: false
   configuration-cache-enabled:
     description: Whether caching build configuration is enabled or not, default to 'false'
     required: false
+    default: false
   configuration-cache-key:
     description: Globs of files to hash in the build root directory, separated by new lines, use best-effort if unset
     required: false
   configuration-cache-exact:
     description: Whether to restore only if exact match, default to 'false'
     required: false
+    default: false
 
 outputs:
   build-scan-url:

src/cache-configuration.ts

@@ -4,7 +4,6 @@ import fs from 'fs'
 import * as core from '@actions/core'
 import * as cache from '@actions/cache'
 
-import * as github from './github-utils'
 import * as crypto from './crypto-utils'
 
 import {inputCacheKeyGlobs, tryDeleteFiles} from './cache-dependencies'
@@ -22,7 +21,7 @@ export async function restoreCachedConfiguration(
     if (fs.existsSync(cachePath)) return
     core.saveState(CONFIGURATION_CACHE_PATH, cachePath)
 
-    const inputCacheExact = github.inputBoolean('configuration-cache-exact')
+    const inputCacheExact = core.getBooleanInput('configuration-cache-exact')
     const cacheKeyGlobs = inputCacheKeyGlobs('configuration-cache-key')
 
     const hash = await crypto.hashFiles(rootDir, cacheKeyGlobs)
@@ -93,5 +92,5 @@ export async function cacheConfiguration(): Promise<void> {
 }
 
 function isConfigurationCacheDisabled(): boolean {
-    return !github.inputBoolean('configuration-cache-enabled', false)
+    return !core.getBooleanInput('configuration-cache-enabled')
 }

src/cache-dependencies.ts

@@ -5,7 +5,6 @@ import * as os from 'os'
 import * as core from '@actions/core'
 import * as cache from '@actions/cache'
 
-import * as github from './github-utils'
 import * as crypto from './crypto-utils'
 
 const DEPENDENCIES_CACHE_PATH = 'DEPENDENCIES_CACHE_PATH'
@@ -21,7 +20,7 @@ export async function restoreCachedDependencies(
     if (fs.existsSync(cachePath)) return
     core.saveState(DEPENDENCIES_CACHE_PATH, cachePath)
 
-    const inputCacheExact = github.inputBoolean('dependencies-cache-exact')
+    const inputCacheExact = core.getBooleanInput('dependencies-cache-exact')
     const cacheKeyGlobs = inputCacheKeyGlobs('dependencies-cache-key')
 
     const hash = await crypto.hashFiles(rootDir, cacheKeyGlobs)
@@ -104,12 +103,12 @@ export function tryDeleteFiles(filePaths: string[]): boolean {
 }
 
 function isDependenciesCacheDisabled(): boolean {
-    return !github.inputBoolean('dependencies-cache-enabled', false)
+    return !core.getBooleanInput('dependencies-cache-enabled')
 }
 
 export function inputCacheKeyGlobs(input: string): string[] {
-    const inputValue = github.inputArrayOrNull(input)
-    return inputValue
+    const inputValue = core.getMultilineInput(input)
+    return inputValue.length > 0
         ? inputValue
         : [
               '**/*.gradle',

src/cache-wrapper.ts

@@ -5,8 +5,6 @@ import * as os from 'os'
 import * as core from '@actions/core'
 import * as cache from '@actions/cache'
 
-import * as github from './github-utils'
-
 const WRAPPER_SLUG = 'WRAPPER_SLUG'
 
 export async function restoreCachedWrapperDist(
@@ -108,13 +106,9 @@ export function extractGradleWrapperSlugFromDistUri(
 
 function isWrapperCacheDisabled(): boolean {
     // Check if either 'distributions' or 'wrapper' cache has been disabled
-    const wrapperCacheEnabled = github.inputBoolean(
-        'wrapper-cache-enabled',
-        true
-    )
-    const distributionsCacheEnabled = github.inputBoolean(
-        'distributions-cache-enabled',
-        true
+    const wrapperCacheEnabled = core.getBooleanInput('wrapper-cache-enabled')
+    const distributionsCacheEnabled = core.getBooleanInput(
+        'distributions-cache-enabled'
     )
     return !wrapperCacheEnabled || !distributionsCacheEnabled
 }

src/github-utils.ts

@@ -1,24 +0,0 @@
-import * as core from '@actions/core'
-
-export function inputOrNull(name: string): string | null {
-    const inputString = core.getInput(name, {required: false})
-    if (inputString.length === 0) {
-        return null
-    }
-    return inputString
-}
-
-export function inputArrayOrNull(name: string): string[] | null {
-    const string = inputOrNull(name)
-    if (!string) return null
-    return string
-        .split('\n')
-        .map(s => s.trim())
-        .filter(s => s !== '')
-}
-
-export function inputBoolean(name: string, defaultValue = false): boolean {
-    const string = inputOrNull(name)
-    if (!string) return defaultValue
-    return string === 'true'
-}

src/main.ts

@@ -2,7 +2,6 @@ import * as core from '@actions/core'
 import * as path from 'path'
 import {parseArgsStringToArgv} from 'string-argv'
 
-import * as github from './github-utils'
 import * as cacheWrapper from './cache-wrapper'
 import * as execution from './execution'
 import * as gradlew from './gradlew'
@@ -41,13 +40,13 @@ async function resolveGradleExecutable(
     workspaceDirectory: string,
     buildRootDirectory: string
 ): Promise<string> {
-    const gradleVersion = github.inputOrNull('gradle-version')
-    if (gradleVersion !== null && gradleVersion !== 'wrapper') {
+    const gradleVersion = core.getInput('gradle-version')
+    if (gradleVersion !== '' && gradleVersion !== 'wrapper') {
         return path.resolve(await provision.gradleVersion(gradleVersion))
     }
 
-    const gradleExecutable = github.inputOrNull('gradle-executable')
-    if (gradleExecutable !== null) {
+    const gradleExecutable = core.getInput('gradle-executable')
+    if (gradleExecutable !== '') {
         if (gradleExecutable.endsWith(gradlew.wrapperFilename())) {
             await cacheWrapper.restoreCachedWrapperDist(
                 path.resolve(gradleExecutable, '..')
@@ -56,9 +55,9 @@ async function resolveGradleExecutable(
         return path.resolve(workspaceDirectory, gradleExecutable)
     }
 
-    const wrapperDirectory = github.inputOrNull('wrapper-directory')
+    const wrapperDirectory = core.getInput('wrapper-directory')
     const gradlewDirectory =
-        wrapperDirectory !== null
+        wrapperDirectory !== ''
             ? path.resolve(workspaceDirectory, wrapperDirectory)
             : buildRootDirectory
 
@@ -69,15 +68,15 @@ async function resolveGradleExecutable(
 }
 
 function resolveBuildRootDirectory(baseDirectory: string): string {
-    const buildRootDirectory = github.inputOrNull('build-root-directory')
+    const buildRootDirectory = core.getInput('build-root-directory')
     const resolvedBuildRootDirectory =
-        buildRootDirectory === null
+        buildRootDirectory === ''
             ? path.resolve(baseDirectory)
             : path.resolve(baseDirectory, buildRootDirectory)
     return resolvedBuildRootDirectory
 }
 
 function parseCommandLineArguments(): string[] {
-    const input = github.inputOrNull('arguments')
-    return input === null ? [] : parseArgsStringToArgv(input)
+    const input = core.getInput('arguments')
+    return parseArgsStringToArgv(input)
 }

src/provision.ts

@@ -7,7 +7,6 @@ import * as cache from '@actions/cache'
 import * as toolCache from '@actions/tool-cache'
 
 import * as gradlew from './gradlew'
-import * as github from './github-utils'
 
 const gradleVersionsBaseUrl = 'https://services.gradle.org/versions'
 
@@ -19,6 +18,11 @@ export async function gradleVersion(version: string): Promise<string> {
         case 'current':
             return gradleCurrent()
         case 'rc':
+            core.warning(
+                `Specifying gradle-version 'rc' has been deprecated. Use 'release-candidate' instead.`
+            )
+            return gradleReleaseCandidate()
+        case 'release-candidate':
             return gradleReleaseCandidate()
         case 'nightly':
             return gradleNightly()
@@ -180,7 +184,7 @@ async function httpGetString(url: string): Promise<string> {
 }
 
 function isDistributionsCacheDisabled(): boolean {
-    return !github.inputBoolean('distributions-cache-enabled', true)
+    return !core.getBooleanInput('distributions-cache-enabled')
 }
 
 interface GradleVersionInfo {