Update jib-gradle-plugin/CHANGELOG for the new option: configurationName
#3111
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #3111 +/- ##
============================================
- Coverage 71.14% 71.12% -0.02%
- Complexity 2314 2315 +1
============================================
Files 278 278
Lines 9782 9790 +8
Branches 991 991
============================================
+ Hits 6959 6963 +4
- Misses 2478 2482 +4
Partials 345 345
Continue to review full report at Codecov.
|
chanseokoh
reviewed
Mar 4, 2021
jib-gradle-plugin/README.md
Outdated
| `skaffold` | [`skaffold`](#skaffold-integration) | See [`skaffold`](#skaffold-integration) | Configures the internal skaffold tasks. This configuration should only be used when integrating with [`skaffold`](#skaffold-integration). | | ||
| `containerizingMode` | `String` | `exploded` | If set to `packaged`, puts the JAR artifact built by the Gradle Java plugin into the final image. If set to `exploded` (default), containerizes individual `.class` files and resources files. | ||
| `allowInsecureRegistries` | `boolean` | `false` | If set to true, Jib ignores HTTPS certificate errors and may fall back to HTTP as a last resort. Leaving this parameter set to `false` is strongly recommended, since HTTP communication is unencrypted and visible to others on the network, and insecure HTTPS is no better than plain HTTP. [If accessing a registry with a self-signed certificate, adding the certificate to your Java runtime's trusted keys](https://github.com/GoogleContainerTools/jib/tree/master/docs/self_sign_cert.md) may be an alternative to enabling this option. | ||
| `configurationName` | `String` | `runtimeClasspath` | Configures the name of the [Gradle Configuration](https://docs.gradle.org/current/dsl/org.gradle.api.artifacts.Configuration.html) to use. It can be used to be selective about the dependencies and artifacts added to the container. |
Member
There was a problem hiding this comment.
This change should be in a separate PR so that we can merge it after making the next release.
Suggested change
| `configurationName` | `String` | `runtimeClasspath` | Configures the name of the [Gradle Configuration](https://docs.gradle.org/current/dsl/org.gradle.api.artifacts.Configuration.html) to use. It can be used to be selective about the dependencies and artifacts added to the container. | |
| `configurationName` | `String` | `runtimeClasspath` | Configures the name of the [Gradle Configuration](https://docs.gradle.org/current/dsl/org.gradle.api.artifacts.ConfigurationContainer.html) to use. It can be used to be selective about the dependencies and artifacts added to the container. |
The new link seems more user-friendly.
Contributor
Author
There was a problem hiding this comment.
Good catch. I will move this change out of this PR.
jib-gradle-plugin/CHANGELOG.md
Outdated
Comment on lines
8
to
13
| - Added an option `configurationName` to specify the name of the [Gradle Configuration](https://docs.gradle.org/current/dsl/org.gradle.api.artifacts.Configuration.html) to use. This change introduces lazy evaluation by exposing the Gradle Property through a getter, which is different from the traditional route of using Gradle Provider and Property. ([#3034](https://github.com/GoogleContainerTools/jib/pull/3034)) | ||
| ```gradle | ||
| jib { | ||
| configurationName.set("myconfig") | ||
| } | ||
| ``` |
Member
There was a problem hiding this comment.
I'm pretty sure you can do configurationName = 'myconfig', but you can double-check. How about this?
Suggested change
| - Added an option `configurationName` to specify the name of the [Gradle Configuration](https://docs.gradle.org/current/dsl/org.gradle.api.artifacts.Configuration.html) to use. This change introduces lazy evaluation by exposing the Gradle Property through a getter, which is different from the traditional route of using Gradle Provider and Property. ([#3034](https://github.com/GoogleContainerTools/jib/pull/3034)) | |
| ```gradle | |
| jib { | |
| configurationName.set("myconfig") | |
| } | |
| ``` | |
| - Added an option `configurationName` to specify the name of the [Gradle Configuration](https://docs.gradle.org/current/dsl/org.gradle.api.artifacts.Configuration.html | |
| ) to use. The option can be lazily configured, for example, using Gradle `Provider` or `Property`. ([#3034](https://github.com/GoogleContainerTools/jib/pull/3034)) | |
| ```gradle | |
| jib { | |
| configurationName.set = 'myconfig' | |
| } |
mpeddada1
changed the title
configurationNameconfigurationName
chanseokoh
reviewed
Mar 5, 2021
jib-gradle-plugin/CHANGELOG.md
Outdated
| - Added an option `configurationName` to specify the name of the [Gradle Configuration](https://docs.gradle.org/current/dsl/org.gradle.api.artifacts.ConfigurationContainer.html) to use. The option can be lazily configured, for example, using Gradle `Provider` or `Property`. ([#3034](https://github.com/GoogleContainerTools/jib/pull/3034)) | ||
| ```gradle | ||
| jib { | ||
| configurationName.set = 'myconfig' |
Member
There was a problem hiding this comment.
Ah, my bad. I think it's just
Suggested change
| configurationName.set = 'myconfig' | |
| configurationName = 'myconfig' |
Right? (I think it worked in this way.)
Contributor
Author
There was a problem hiding this comment.
My bad, thank you. Just did a quick test and configurationName = 'myConfig' works.
chanseokoh
approved these changes
Mar 5, 2021
Member
chanseokoh
left a comment
chanseokoh
left a comment
There was a problem hiding this comment.
I think the syntax is invalid, but other than that, LGTM.
chanseokoh
approved these changes
Mar 8, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For #3034