@@ -53,12 +53,12 @@ mvn -Penable-integration-tests clean verify
|
53 | 53 |
|
54 | 54 | ## Code Samples
|
55 | 55 |
|
56 |
| -Code Samples must be bundled in separate Maven modules, and guarded by a |
57 |
| -Maven profile with the name `enable-samples`. |
| 56 | +All code samples must be in compliance with the [java sample formatting guide][3]. |
| 57 | +Code Samples must be bundled in separate Maven modules. |
58 | 58 |
|
59 | 59 | The samples must be separate from the primary project for a few reasons:
|
60 |
| -1. Primary projects have a minimum Java version of Java 7 whereas samples have |
61 |
| -a minimum Java version of Java 8. Due to this we need the ability to |
| 60 | +1. Primary projects have a minimum Java version of Java 8 whereas samples can have |
| 61 | +Java version of Java 11. Due to this we need the ability to |
62 | 62 | selectively exclude samples from a build run.
|
63 | 63 | 2. Many code samples depend on external GCP services and need
|
64 | 64 | credentials to access the service.
|
@@ -68,39 +68,16 @@ The samples must be separate from the primary project for a few reasons:
|
68 | 68 | ### Building
|
69 | 69 |
|
70 | 70 | ```bash
|
71 |
| -mvn -Penable-samples clean verify |
| 71 | +mvn clean verify |
72 | 72 | ```
|
73 | 73 |
|
74 | 74 | Some samples require access to GCP services and require a service account:
|
75 | 75 |
|
76 | 76 | ```bash
|
77 | 77 | export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account.json
|
78 |
| -mvn -Penable-samples clean verify |
| 78 | +mvn clean verify |
79 | 79 | ```
|
80 | 80 |
|
81 |
| -### Profile Config |
82 |
| - |
83 |
| -1. To add samples in a profile to your Maven project, add the following to your |
84 |
| -`pom.xml` |
85 |
| - |
86 |
| -```xml |
87 |
| -<project> |
88 |
| -[...] |
89 |
| -<profiles> |
90 |
| -<profile> |
91 |
| -<id>enable-samples</id> |
92 |
| -<modules> |
93 |
| -<module>sample</module> |
94 |
| -</modules> |
95 |
| -</profile> |
96 |
| -</profiles> |
97 |
| -[...] |
98 |
| -</project> |
99 |
| -``` |
100 |
| - |
101 |
| -2. [Activate](#profile-activation) the profile. |
102 |
| -3. Define your samples in a normal Maven project in the `samples/` directory. |
103 |
| - |
104 | 81 | ### Code Formatting
|
105 | 82 |
|
106 | 83 | Code in this repo is formatted with
|
@@ -110,30 +87,6 @@ To run formatting on your project, you can run:
|
110 | 87 | mvn com.coveo:fmt-maven-plugin:format
|
111 | 88 | ```
|
112 | 89 |
|
113 |
| -### Profile Activation |
114 |
| - |
115 |
| -To include code samples when building and testing the project, enable the |
116 |
| -`enable-samples` Maven profile. |
117 |
| - |
118 |
| -#### Command line |
119 |
| - |
120 |
| -To activate the Maven profile on the command line add `-Penable-samples` to your |
121 |
| -Maven command. |
122 |
| - |
123 |
| -#### Maven `settings.xml` |
124 |
| - |
125 |
| -To activate the Maven profile in your `~/.m2/settings.xml` add an entry of |
126 |
| -`enable-samples` following the instructions in [Active Profiles][2]. |
127 |
| - |
128 |
| -This method has the benefit of applying to all projects you build (and is |
129 |
| -respected by IntelliJ IDEA) and is recommended if you are going to be |
130 |
| -contributing samples to several projects. |
131 |
| - |
132 |
| -#### IntelliJ IDEA |
133 |
| - |
134 |
| -To activate the Maven Profile inside IntelliJ IDEA, follow the instructions in |
135 |
| -[Activate Maven profiles][3] to activate `enable-samples`. |
136 |
| - |
137 | 90 | [1]: https://cloud.google.com/docs/authentication/getting-started#creating_a_service_account
|
138 | 91 | [2]: https://maven.apache.org/settings.html#Active_Profiles
|
139 |
| -[3]: https://www.jetbrains.com/help/idea/work-with-maven-profiles.html#activate_maven_profiles |
| 92 | +[3]: https://.com/GoogleCloudPlatform/java-docs-samples/blob/main/SAMPLE_FORMAT.md |
0 commit comments