Skip to content

Documentation updates #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ The recommended way to execute any Gradle build is with the help of the [Gradle
```yaml
name: Build

on: [ push ]
on:
push:

jobs:
build:
Expand Down Expand Up @@ -48,7 +49,9 @@ Simply add this as a new workflow file to your repository (eg `.github/workflows
```yaml
name: Dependency Submission

on: [ push ]
on:
push:
branches: [ 'main' ]

permissions:
contents: write
Expand Down Expand Up @@ -80,7 +83,10 @@ The action should be run in the root of the repository, as it will recursively s

```yaml
name: "Validate Gradle Wrapper"
on: [push, pull_request]

on:
push:
pull_request:

jobs:
validation:
Expand Down
4 changes: 3 additions & 1 deletion dependency-submission/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ Simply add this as a new workflow file to your repository (eg `.github/workflows
```yaml
name: Dependency Submission

on: [ push ]
on:
push:
branches: ['main']

permissions:
contents: write
Expand Down
18 changes: 14 additions & 4 deletions docs/dependency-submission.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ Simply add this as a new workflow file to your repository (eg `.github/workflows
```yaml
name: Dependency Submission

on: [ push ]
on:
push:
branches: [ 'main' ]

permissions:
contents: write
Expand Down Expand Up @@ -104,6 +106,11 @@ In some cases, the default action configuration will not be sufficient, and addi

See the [Action Metadata file](../dependency-submission/action.yml) for a more detailed description of each input parameter.

The `GitHub Dependency Graph Gradle Plugin` can be further
[configured via a number of environment variables](https://github.com/gradle/github-dependency-graph-gradle-plugin?#required-environment-variables).
These will be automatically set by the `dependency-submission` action, but you may override these values
by setting them explicitly in your workflow file.

# Resolving a dependency vulnerability

## Finding the source of a dependency vulnerability
Expand Down Expand Up @@ -292,7 +299,8 @@ Example of a pull request workflow that executes a build for a pull request and
```yaml
name: Dependency review for pull requests

on: [ pull_request ]
on:
pull_request:

permissions:
contents: write
Expand Down Expand Up @@ -327,7 +335,8 @@ Because of this restriction, we require 2 separate workflows in order to generat
```yaml
name: Generate and save dependency graph

on: [ pull_request ]
on:
pull_request:

permissions:
contents: read # 'write' permission is not available
Expand Down Expand Up @@ -381,7 +390,8 @@ Here's an example of a separate "Dependency Review" workflow that will wait for
```yaml
name: dependency-review

on: [ pull_request ]
on:
pull_request:

permissions:
contents: read
Expand Down
3 changes: 2 additions & 1 deletion docs/setup-gradle.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ The recommended way to execute any Gradle build is with the help of the [Gradle
```yaml
name: Run Gradle on every push

on: push
on:
push:

jobs:
gradle:
Expand Down
5 changes: 4 additions & 1 deletion docs/wrapper-validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,10 @@ Here's a sample complete workflow you can add to your repositories:
**`.github/workflows/gradle-wrapper-validation.yml`**
```yaml
name: "Validate Gradle Wrapper"
on: [push, pull_request]

on:
push:
pull_request:

jobs:
validation:
Expand Down
3 changes: 2 additions & 1 deletion setup-gradle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ The recommended way to execute any Gradle build is with the help of the [Gradle
```yaml
name: Build

on: [ push ]
on:
push:

jobs:
build:
Expand Down
5 changes: 4 additions & 1 deletion wrapper-validation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ The action should be run in the root of the repository, as it will recursively s

```yaml
name: "Validate Gradle Wrapper"
on: [push, pull_request]

on:
push:
pull_request:

jobs:
validation:
Expand Down