Prefer ‘release-candidate’ instead of ‘rc’

This makes the version alias match other places where we reference a release candidate version.
The 'rc' alias is still supported, but emits a deprecation warning.
This commit is contained in:
Daz DeBoer 2021-06-24 15:59:03 -07:00
parent 5423935c9b
commit b9684c0cf5
No known key found for this signature in database
GPG key ID: DD6B9F0B06683D5D
3 changed files with 12 additions and 7 deletions

View file

@ -31,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

View file

@ -92,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:
@ -116,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
```

View file

@ -19,6 +19,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()