jruby-gradle-plugin

History

Uwe Kubosch 771db5062f Fix documentation site generation.		2023-05-18 12:59:24 +02:00
..
src	Update copyright year from 2020 to 2023	2023-05-16 10:20:02 +02:00
README.adoc	Fix documentation site generation.	2023-05-18 12:59:24 +02:00
build.gradle	(#386 ) Setup initial publishing from GH Actions	2021-05-02 21:43:57 +02:00

README.adoc

Core plugin

The core plugin is not meant for consumption by build script authors. It is rather targeted at authors of other plugins that might require some core JRuby functionality without the conventional and extensions that is associated with other JRuby-Gradle plugins.

This plugin offers the following functionality:

A repository handler extension to resolve GEMs directly from https://rubygems.org or another GEM repository that serves the same REST API.
Conversion between GEM-style and Ivy-style dependencies notations.
An abstract task class (AbstractJRubyPrepare) for preparing local GEM + JAR installations.

Getting Started

Compatibility

This plugin requires Gradle 4.3 or better

Installing

build.gradle

plugins {
  id 'com.github.jruby-gradle.core' version 'VERSION-OF-PLUGIN'
}

Adding repositories

build.gradle

repositories {
    ruby.gems() // (1)
    ruby.gems { // (2)
        prerelease = true
    }
    ruby.gems('https://foo.bar') // (3)
    ruby.gems('acme-rubygems', 'https://foo.bar') // (4)

    ruby.mavengems() // (5)
    ruby.mavengems('https://foo.bar') // (6)
    ruby.mavengems('acme-rubygems', 'https://foo.bar') // (7)
}

Proxy rubygems.org directly and use rubygems as the Maven coordinate group.
Proxy rubygems.org directly and allow prerelease GEMs to be considered. Use rubygems as the Maven coordinate group.
Proxy a custom rubygems repository.
Proxy a custom rubygems repository and assign a custom Maven coordinate group.
Adds a Maven repository that uses the one official supported by the JRuby group. In order to use this, GEM dependencies should all be placed in the rubygems group.
Adds a custom Maven repository that will proxy a GEMs repository. In order to use this, GEM dependencies should all be placed in the rubygems group.
Adds a custom Maven repository that will proxy a GEMs repository, but allocate a custom dedicated Maven group. This is useful where you would want to use both the public repository and your own, but you want to save network query traffic, by only query repositories where you know the dependencies should exist.

Advanced

Customising GEM resolving

By default the rubygems configuration and others added via ruby.mavengems() and ruby.gems() will have additional resolving strategies applied that mimicks GEM behaviour rather then Gradle behaviour. It is possible to customise this behaviour.

build.gradle

gemResolverStrategy {
  excludeConfigurations 'foo', 'bar'  // (1)
  excludeModule 'foo.*' // (2)
  excludeModule 'foo.*', /1\.2.*/ // (3)
  useGemVersionResolver 'gems2' // (4)
}

Exclude configurations foo and bar from being considered for GEM resolver strategies.
Exclude module that matches regular expression from GEM resolver strategies.
Exclude module and version that matches regular expression from GEM resolver strategies.
Apply GEM resolver strategies to a specific configuration.

Last updated 2024-04-29 14:23:27 UTC

</html>