Skip to content

Commit 8ace879

Browse files
committed
Polish readme a bit
1 parent d84c36c commit 8ace879

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

.github/actions/gradle/README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# Composite Github Actions
22

3-
The composite actions provided here will simplify running the validation scripts in your Github Action workflow.
3+
The composite actions provided here will simplify running the build validation scripts from your GitHub Actions workflow.
44

55
## Usage
66

7-
Create a Github Action workflow, fulfilling the build requirements (add JDK...) and then add the following steps (replacing the placeholders):
7+
Create a GitHub Actions workflow, add the steps to configure the build requirements like JDK, etc., and then add the
8+
following steps to invoke the actual experiments:
89

910
```yaml
1011
steps:
11-
# Download scripts latest version
12+
# Download the latest version of the build validation scripts
1213
- uses: gradle/gradle-enterprise-build-validation-scripts/.github/actions/gradle/[email protected]
1314
with:
1415
token: ${{ secrets.GITHUB_TOKEN }}
@@ -18,21 +19,22 @@ steps:
1819
gitRepo: <PROJECT_GIT_URL>
1920
gitBranch: <PROJECT_BRANCH>
2021
tasks: <PROJECT_BUILD_TASK>
21-
gradleEnterpriseUrl: <GRADLE_ENTERPRISE_URL>
22+
...
2223
# Run experiment 2
2324
- uses: gradle/gradle-enterprise-build-validation-scripts/.github/actions/gradle/[email protected]
2425
with:
2526
gitRepo: <PROJECT_GIT_URL>
2627
gitBranch: <PROJECT_BRANCH>
2728
tasks: <PROJECT_BUILD_TASK>
28-
gradleEnterpriseUrl: <GRADLE_ENTERPRISE_URL>
29-
# Run experiment 3
29+
...
30+
# Run experiment 3
3031
- uses: gradle/gradle-enterprise-build-validation-scripts/.github/actions/gradle/[email protected]
3132
with:
3233
gitRepo: <PROJECT_GIT_URL>
3334
gitBranch: <PROJECT_BRANCH>
3435
tasks: <PROJECT_BUILD_TASK>
35-
gradleEnterpriseUrl: <GRADLE_ENTERPRISE_URL>
36+
...
3637
```
3738

38-
You can then navigate the workflow output and click the investigation links provided by the script.
39+
Once the workflow has been triggered and finishes executing, you can navigate to the workflow's output and investigate the summary
40+
produced by the build validation scripts.

0 commit comments

Comments
 (0)