feat: add new configuration necessary to support auto-value #136
Conversation
This file contains 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
Normally we would want to include auto-value in java-shared-dependencies, however auto-value includes a compiler extension and requires build configuration. #### Dependencies This change adds a dependencyManagement section with contains auto-value-annotations to manage which version of auto-value-annotations is used by projects and included in the dependency tree. #### Profiles Two new profiles have been added with the necessary configuration to include auto-value in the annotationProcessorPath when compiling. Auto value does not support java7 across all its artifacts consistently and requires us to have build configuration for java7 and java8+ to deal with this fact. When we drop support for java7 the autovalue-java7 profile can be deleted, and the jdk based activation of autovalue-java8 can be removed. ##### Activation Activation of each of the profiles is accomplished using a combination of jdk version and file-exists rules. Not all modules underneath this shared config use auto-value and thus we don't want to modify the annotationProcessorPath for everything. This allows the use of auto-value to be opt-in per module. To use either autovalue-java* profile, create an empty file in the module root named `EnableAutoValue.txt`. When the maven config is loaded it will look for this file, and if present activate the respective profile based on which version of java is running. Related to: googleapis/java-shared-dependencies#37
googlebot
added
the
cla: yes
|
/cc @saturnism |
|
I'm happy to change the activation file to something else if we like that better. It does need to be resolved from |
|
Take a look at googleapis/java-firestore#221 to see this "in use" for Firestores google-cloud-firestore module |
stephaniewang526
approved these changes
May 18, 2020
|
I'm not sure if this is a great idea. We want to make sure it doesn't leak to anything a customer sees. |
|
These profiles are already present in the Firestore and BigQuery clients. Their impact to users of our libraries is none (and guarded more with the new file/exists activation rule). Since these are changes that are part of the |
|
SGTM |
chingor13
approved these changes
May 19, 2020
gcf-merge-on-green bot
pushed a commit
that referenced
this pull request
May 19, 2020
🤖 I have created a release \*beep\* \*boop\* --- ## [0.6.0](https://www.github.com/googleapis/java-shared-config/compare/v0.5.0...v0.6.0) (2020-05-19) ### Features * add new configuration necessary to support auto-value ([#136](https://www.github.com/googleapis/java-shared-config/issues/136)) ([c14689b](https://www.github.com/googleapis/java-shared-config/commit/c14689b8791c173687f719d73156a989aedd7ba6)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please).
saturnism
reviewed
May 19, 2020
| <dependency> | ||
| <groupId>com.google.auto.value</groupId> | ||
| <artifactId>auto-value-annotations</artifactId> | ||
| <version>${auto-value-annotation.version}</version> |
This was referenced Jan 4, 2022
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.
Normally we would want to include auto-value in
java-shared-dependencies, however auto-value includes a compiler
extension and requires build configuration.
Dependencies
This change adds a dependencyManagement section with contains
auto-value-annotations to manage which version of
auto-value-annotations is used by projects and included in the
dependency tree.
Profiles
Two new profiles have been added with the necessary
configuration to include auto-value in the annotationProcessorPath
when compiling.
Auto value does not support java7 across all its artifacts
consistently and requires us to have build configuration for java7
and java8+ to deal with this fact. When we drop support for java7 the
autovalue-java7 profile can be deleted, and the jdk based activation
of autovalue-java8 can be removed.
Activation
Activation of each of the profiles is accomplished using a combination
of jdk version and file-exists rules. Not all modules underneath this
shared config use auto-value and thus we don't want to modify the
annotationProcessorPath for everything. This allows the use of
auto-value to be opt-in per module.
To use either autovalue-java* profile, create an empty file in the
module root named
EnableAutoValue.txt. When the maven config isloaded it will look for this file, and if present activate the
respective profile based on which version of java is running.
Related to: googleapis/java-shared-dependencies#37