actions/gradle-build-action
1
0
Fork 0
mirror of https://github.com/gradle/gradle-build-action.git synced 2024-11-21 15:51:03 -05:00
Code Issues Projects Releases Packages Wiki Activity

Fix docs for dependency-graph param

Browse source
This commit is contained in:
daz 2024-01-13 12:55:55 -07:00
parent 7099569988
commit 5516b39940
No known key found for this signature in database
1 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -476,9 +476,10 @@ You enable GitHub Dependency Graph support by setting the `dependency-graph` act
| Option | Behaviour | | Option | Behaviour |
| --- | --- | | --- | --- |
| `disabled` | Do not generate a dependency graph for any build invocations.<p>This is the default. | | `disabled` | Do not generate a dependency graph for any build invocations.<p>This is the default. |
| `generate` | Generate a dependency graph snapshot for each build invocation, saving as a workflow artifact. | | `generate` | Generate a dependency graph snapshot for each build invocation. |
| `generate-and-submit` | As per `generate`, but any generated dependency graph snapshots will be submitted at the end of the job. | | `generate-and-submit` | Generate a dependency graph snapshot for each build invocation, and submit these via the Dependency Submission API on completion of the job. |
| `download-and-submit` | Download any previously saved dependency graph snapshots, submitting them via the Dependency Submission API. This can be useful to collect all snapshots in a matrix of builds and submit them in one step. | | `generate-and-upload` | Generate a dependency graph snapshot for each build invocation, saving as a workflow artifact. |
| `download-and-submit` | Download any previously saved dependency graph snapshots, and submit them via the Dependency Submission API. This can be useful to submit [dependency graphs for pull requests submitted from a repository forks](#dependency-graphs-for-pull-request-workflows). |
Example of a CI workflow that generates and submits a dependency graph: Example of a CI workflow that generates and submits a dependency graph:
```yaml ```yaml
@ -704,6 +705,9 @@ name: run-build-and-generate-dependency-snapshot
on: on:
pull_request: pull_request:
permissions:
contents: read
jobs: jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
@ -712,7 +716,7 @@ jobs:
- name: Setup Gradle to generate and submit dependency graphs - name: Setup Gradle to generate and submit dependency graphs
uses: gradle/gradle-build-action@v2 uses: gradle/gradle-build-action@v2
with: with:
dependency-graph: generate # Only generate in this job dependency-graph: generate-and-upload # Generate graphs and save as workflow artifacts
- name: Run a build, generating the dependency graph snapshot which will be submitted - name: Run a build, generating the dependency graph snapshot which will be submitted
run: ./gradlew build run: ./gradlew build
``` ```
@ -726,6 +730,9 @@ on:
workflows: ['run-build-and-generate-dependency-snapshot'] workflows: ['run-build-and-generate-dependency-snapshot']
types: [completed] types: [completed]
permissions:
contents: write
jobs: jobs:
submit-dependency-graph: submit-dependency-graph:
runs-on: ubuntu-latest runs-on: ubuntu-latest
@ -733,7 +740,7 @@ jobs:
- name: Retrieve dependency graph artifact and submit - name: Retrieve dependency graph artifact and submit
uses: gradle/gradle-build-action@v2 uses: gradle/gradle-build-action@v2
with: with:
dependency-graph: download-and-submit dependency-graph: download-and-submit # Download saved workflow artifacts and submit
``` ```
### Integrating `dependency-review-action` for pull request workflows ### Integrating `dependency-review-action` for pull request workflows