Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vierbergenlars/ci-detect-gradle-plugin
:robot: A gradle plugin that checks if it is running on a continuous integration server and gives you access to the build metadata.
https://github.com/vierbergenlars/ci-detect-gradle-plugin
continuous-integration gradle gradle-plugin
Last synced: about 2 months ago
JSON representation
:robot: A gradle plugin that checks if it is running on a continuous integration server and gives you access to the build metadata.
- Host: GitHub
- URL: https://github.com/vierbergenlars/ci-detect-gradle-plugin
- Owner: vierbergenlars
- License: apache-2.0
- Created: 2019-08-03T09:18:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-13T04:56:45.000Z (over 1 year ago)
- Last Synced: 2024-10-12T14:15:15.526Z (2 months ago)
- Topics: continuous-integration, gradle, gradle-plugin
- Language: Java
- Homepage:
- Size: 185 KB
- Stars: 15
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CI detect plugin
[](https://github.com/vierbergenlars/ci-detect-gradle-plugin/actions?query=workflow%3ACI+branch%3Amaster)
[](https://sonarcloud.io/dashboard?id=vierbergenlars_ci-detect-gradle-plugin)
[](https://plugins.gradle.org/plugin/be.vbgn.ci-detect)
A gradle plugin that checks if it is running on a continuous integration platform and gives you access to the build metadata.
## Installation
```gradle
plugins {
// Check https://plugins.gradle.org/plugin/be.vbgn.ci-detect for the latest version
id "be.vbgn.ci-detect" version "0.1.0"
}
```
## Usage
This plugin gives you easy and consistent access to environment variables that CI platforms automatically add, independent of which CI solution you are using.
CI build metadata is exposed through the `ci` variable in your `build.gradle`. It can also be used programmatically from other Gradle plugins or code.
```gradle
// Basic information
ci.isCi() // => true or false, depending on if you are running in a CI server or not
ci.reference // The current branch or tag that is being built
// Branch builds
ci.branch // The current branch that is being built
// Pull requests
ci.isPullRequest() // => true/false
ci.pullRequest // Pull request identifier (usually a string containing a number, depends on your SCM system)
ci.pullRequestTargetBranch // Branch where the pullrequest will be merged into
// Tags
ci.isTag() // => true/false, depending on if this is a git tag that is being built or not
ci.tag // The tag name that is being built
// Platform information
ci.platform // => A string identifying the platform the build is run on.
```
Supported CI platforms:
* [Travis CI](https://travis-ci.org)
* [Jenkins](https://jenkins.io)
* [GitLab CI](https://about.gitlab.com/product/continuous-integration/)
* [Github actions](https://github.com/features/actions)
* [Appveyor](https://www.appveyor.com)
### Programmatic usage
```java
import be.vbgn.gradle.cidetect.CiInformation;
CiInformation ci = CiInformation.detect(); // Attempts to detect CI from environment variables
CiInformation ci = CIInformation.detect(project); // Gives CI detectors access to the gradle Project variable, which may be used by detectors to extract additional information
```
# Extending
You can provide extra CI detectors by creating a provider extending [`be.vbgn.gradle.cidetect.provider.CiInformationProvider`](./src/main/java/be/vbgn/gradle/cidetect/provider/CiInformationProvider.java).
There are 2 ways to register extra CI detectors:
* Using the ServiceLoader mechanism: [registering it as a service](https://docs.oracle.com/javase/7/docs/api/java/util/ServiceLoader.html) and placing your jar on the classpath.
* Calling `CiInformationProvider#registerProvider()` from a separate Gradle plugin that is applied **before** `be.vbgn.ci-detect`.
For examples of providers, you can have a look at [the builtin providers](./src/main/java/be/vbgn/gradle/cidetect/impl).
# Development
## Creating a release
Every git tag is automatically published to the gradle plugins repository by Travis-CI.
This plugin follows SemVer and tags are managed with Reckon.
To create a release from a commit, use `./gradlew reckonTagPush -Preckon.scope=patch -Preckon.stage=final` to create a new patch release.
Tests are required to pass before a new release can be tagged.