actions/README.md
daz 40c351e1fe
Improve documentation
- Provide summary of each action on main page
- Extract detailed documentation for each action
- Document usage with forked repositories
2024-01-22 16:15:33 -07:00

1.8 KiB

GitHub Actions for Gradle builds

This repository contains a set of GitHub Actions that are useful for building Gradle projects on GitHub.

The setup-gradle action

A simple wrapper around gradle/gradle-build-action, removing the deprecated arguments parameter (and thus removing the ability to execute gradle). The intention is to eventually deprecate gradle-build-action with this being the replacement.

Example usage

name: Build

on:
  workflow_dispatch:
  push:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout sources
      uses: actions/checkout@v4
    - name: Setup Gradle
      uses: gradle/actions/setup-gradle@v0
    - name: Build with Gradle
      run: ./gradlew build

See the gradle-build-action documentation for a full description of this action.

The dependency-submission action

Generates and submits a dependency graph for a Gradle project, allowing GitHub to alert about reported vulnerabilities in your project dependencies.

The following workflow will generate a dependency graph for a Gradle project and submit it immediately to the repository via the Dependency Submission API. For most projects, this default configuration should be all that you need.

Simply add this as a new workflow file to your repository (eg .github/workflows/dependency-submission.yml).

name: Dependency Submission

on:
  push:
    branches:
    - main

permissions:
  contents: write

jobs:
  dependency-submission:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout sources
      uses: actions/checkout@v4
    - name: Generate and submit dependency graph
      uses: gradle/actions/dependency-submission@v0

See the full action documentation for more advanced usage scenarios.