Improve documentation in starter workflow

- Remove "optional" flag from dependency-submission
- Add example of running without Gradle wrapper
- Link to action docs
This commit is contained in:
daz
2024-01-31 13:29:02 -07:00
parent 2d30c1b64c
commit b0b88404ff
+17 -2
View File
@@ -28,13 +28,26 @@ jobs:
java-version: '17'
distribution: 'temurin'
# Configure Gradle for optimal use in GiHub Actions, including caching of downloaded dependencies.
# See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md
- name: Setup Gradle
uses: gradle/actions/setup-gradle@ec92e829475ac0c2315ea8f9eced72db85bb337a # v3.0.0
- name: Build with Gradle
- name: Build with Gradle Wrapper
run: ./gradlew build
# Optional: Uploads the full dependency graph to GitHub to enable Dependabot alerts
# NOTE: The Gradle Wrapper is the default and recommended way to run Gradle (https://docs.gradle.org/current/userguide/gradle_wrapper.html).
# If your project does not have the Gradle Wrapper configured, you can use the following configuration
# to run Gradle with a specified version.
#
# - name: Setup Gradle
# uses: gradle/actions/setup-gradle@ec92e829475ac0c2315ea8f9eced72db85bb337a # v3.0.0
# with:
# gradle-version: '8.5'
#
# - name: Build with Gradle 8.5
# run: gradle build
dependency-submission:
runs-on: ubuntu-latest
@@ -49,5 +62,7 @@ jobs:
java-version: '17'
distribution: 'temurin'
# Genereates and submits a dependency graph, enabling Dependabot Alerts for all project dependencies.
# See: https://github.com/gradle/actions/blob/main/dependency-submission/README.md
- name: Generate and submit dependency graph
uses: gradle/actions/dependency-submission@ec92e829475ac0c2315ea8f9eced72db85bb337a # v3.0.0