Move ruby.gems() first in order of documentation

This commit is contained in:
Schalk Cronje 2020-01-17 23:20:46 +01:00
parent d764de4e8e
commit 5249a5829d
1 changed files with 15 additions and 15 deletions

View File

@ -30,25 +30,25 @@ plugins {
[source,groovy]
----
repositories {
ruby.mavengems() // <1>
ruby.mavengems('https://foo.bar') // <2>
ruby.mavengems('acme-rubygems', 'https://foo.bar') // <3>
ruby.gems() // <4>
ruby.gems { // <5>
ruby.gems() // <1>
ruby.gems { // <2>
prerelease = true
}
ruby.gems('https://foo.bar') // <6>
ruby.gems('acme-rubygems', 'https://foo.bar') // <7>
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>
}
----
<1> 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.
<2> 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.
<3> 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.
<4> Proxy rubygems.org directly and use `rubygems` as the Maven coordinate group.
<5> Proxy rubygems.org directly and allow prerelease GEMs to be considered. Use `rubygems` as the Maven coordinate group.
<6> Proxy a custom rubygems repository.
<7> Proxy a custom rubygems repository and assign a custom Maven coordinate group.
<1> Proxy rubygems.org directly and use `rubygems` as the Maven coordinate group.
<2> Proxy rubygems.org directly and allow prerelease GEMs to be considered. Use `rubygems` as the Maven coordinate group.
<3> Proxy a custom rubygems repository.
<4> Proxy a custom rubygems repository and assign a custom Maven coordinate group.
<5> 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.
<6> 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.
<7> 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