https://github.com/eskatos/gradle-github-actions-plugin

Gradle Plugin for Github Actions
https://github.com/eskatos/gradle-github-actions-plugin

github-actions gradle

Last synced: 4 months ago
JSON representation

Gradle Plugin for Github Actions

• Host: GitHub
• URL: https://github.com/eskatos/gradle-github-actions-plugin
• Owner: eskatos
• License: apache-2.0
• Created: 2019-09-21T17:41:58.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-17T11:54:22.000Z (over 1 year ago)
• Last Synced: 2024-10-04T19:06:09.670Z (4 months ago)
• Topics: github-actions, gradle
• Language: Kotlin
• Homepage: https://plugins.gradle.org/plugin/org.nosphere.gradle.github.actions
• Size: 861 KB
• Stars: 29
• Watchers: 6
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Gradle Plugin for Github Actions

This Gradle plugin allows your build to easily get Github Actions environment and tag Gradle Build Scans accordingly.

Also see the [Gradle Command](https://github.com/marketplace/actions/gradle-build-action) Github Action that allows to execute Gradle commands.

[![Build Status](https://github.com/eskatos/gradle-github-actions-plugin/workflows/CI/badge.svg)](https://github.com/eskatos/gradle-github-actions-plugin/actions)

## Usage

```kotlin

plugins {

    id("org.nosphere.gradle.github.actions") version "1.4.0"

}

// for example:

if (githubActions.running.get()) {

    println("Commit SHA: ${githubActions.environment.sha.get()}")

}

```

If you have the Gradle Enterprise or Gradle Build Scan plugin applied, or use `--scan`, your build scans will automatically be tagged `github:action`, have a link to the GitHub Action run and have the following custom values attached:

![tag](src/docs/images/build-scan-info.png "Build Scan info")

![tag](src/docs/images/build-scan-values.png "Build Scan values")

https://scans.gradle.com/s/iputsr55ifwtq

You can disable that or change the tag and values prefix:

```kotlin

githubActions.buildScan {

    autoTag.set(false)

    autoTagPrefix.set("ga:")

}

```

## Compatibility matrix

| Plugin  | Min Java | Min Gradle | Max Gradle | Build Scan | Configuration Cache

|---------| --- |------------|------------| --- | ---

| `1.4.x` | `1.8` | `7.4`      | `8.x`      | `>= 3.0` | 🟢

| `1.3.x` | `1.8` | `6.1`      | `7.x`      | `>= 3.0` | 🟢

| `1.2.x` | `1.8` | `6.1`      | `7.x`      | `>= 3.0` | 🟢

| `1.1.x` | `1.8` | `5.2`      | `6.x`      | `>= 1.1` | 🔴

| `1.0.x` | `1.8` | `5.2`      | `6.x`      | `>= 1.1` | 🔴