From e9602f4ce23d8d4df718d2ffa0d998185e8f6125 Mon Sep 17 00:00:00 2001
From: Srikanta <srnagar@microsoft.com>
Date: Tue, 3 Dec 2019 17:07:22 -0800
Subject: [PATCH 1/3] Add maven profile to verify readme

---
 pom.client.xml                                | 91 ++++++++++++++++---
 .../com/azure/core/test/ReadmeSamples.java    |  2 +-
 2 files changed, 81 insertions(+), 12 deletions(-)

diff --git a/pom.client.xml b/pom.client.xml
index b5284abab88f..b313e5997dc6 100644
--- a/pom.client.xml
+++ b/pom.client.xml
@@ -946,19 +946,19 @@
                       <goals>
                           <goal>exec</goal>
                       </goals>
+                      <configuration>
+                        <executable>python</executable>
+                        <workingDirectory>${project.basedir}</workingDirectory>
+                        <arguments>
+                          <argument>../../../eng/pipelines/scripts/generate_overview_from_readme.py</argument>
+                          <argument>--rf</argument>
+                          <argument>${project.basedir}/README.md</argument>
+                          <argument>--v</argument>
+                          <argument>${project.version}</argument>
+                        </arguments>
+                      </configuration>
                   </execution>
               </executions>
-              <configuration>
-                <executable>python</executable>
-                <workingDirectory>${project.basedir}</workingDirectory>
-                <arguments>
-                      <argument>../../../eng/pipelines/scripts/generate_overview_from_readme.py</argument>
-                      <argument>--rf</argument>
-                      <argument>${project.basedir}/README.md</argument>
-                      <argument>--v</argument>
-                      <argument>${project.version}</argument>
-                </arguments>
-              </configuration>
           </plugin>
           <!-- Add the overview argument to the javadoc args -->
           <plugin>
@@ -972,6 +972,75 @@
          </plugins>
       </build>
     </profile>
+
+    <profile>
+      <id>readme-codesnippet</id>
+      <activation>
+        <property>
+          <name>readme-codesnippet</name>
+        </property>
+      </activation>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>exec-maven-plugin</artifactId>
+            <version>1.2.1</version> <!-- {x-version-update;org.codehaus.mojo:exec-maven-plugin;external_dependency} -->
+            <executions>
+              <execution>
+                <id>code-snippet-for-readme</id>
+                <phase>prepare-package</phase>
+                <goals>
+                  <goal>exec</goal>
+                </goals>
+                <configuration>
+                  <executable>npx</executable>
+                  <arguments>
+                    <argument>embedme</argument>
+                    <argument>sdk/**/**/README.md</argument>
+                  </arguments>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+
+    <profile>
+      <id>verify-readme</id>
+      <activation>
+        <os>
+          <family>unix</family>
+        </os>
+      </activation>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>exec-maven-plugin</artifactId>
+            <version>1.2.1</version> <!-- {x-version-update;org.codehaus.mojo:exec-maven-plugin;external_dependency} -->
+            <executions>
+              <execution>
+                <id>verify-readme-codesnippet</id>
+                <phase>prepare-package</phase>
+                <goals>
+                  <goal>exec</goal>
+                </goals>
+                <configuration>
+                  <executable>npx</executable>
+                  <arguments>
+                    <argument>embedme</argument>
+                    <argument>--verify</argument>
+                    <argument>sdk/**/**/README.md</argument>
+                  </arguments>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
   </profiles>
 
   <modules>
diff --git a/sdk/core/azure-core-test/src/samples/java/com/azure/core/test/ReadmeSamples.java b/sdk/core/azure-core-test/src/samples/java/com/azure/core/test/ReadmeSamples.java
index 3edada2f65de..0959b95820c6 100644
--- a/sdk/core/azure-core-test/src/samples/java/com/azure/core/test/ReadmeSamples.java
+++ b/sdk/core/azure-core-test/src/samples/java/com/azure/core/test/ReadmeSamples.java
@@ -34,7 +34,7 @@ public class SessionTests extends TestBase {
          * Use JUnit or TestNG annotation here for your testcase
          */
         public void fooTest() {
-            // Do some network calls.
+            // Do some network service calls.
         }
     }
 

From 9aeb299048d5c4477be0ddbc0a7a2a5f1e470f26 Mon Sep 17 00:00:00 2001
From: Srikanta <srnagar@microsoft.com>
Date: Tue, 3 Dec 2019 17:19:32 -0800
Subject: [PATCH 2/3] Revert changes to readme to pass the CI pipeline

---
 pom.client.xml                                | 46 +++++++++----------
 .../com/azure/core/test/ReadmeSamples.java    |  2 +-
 2 files changed, 24 insertions(+), 24 deletions(-)

diff --git a/pom.client.xml b/pom.client.xml
index b313e5997dc6..8f4b37063272 100644
--- a/pom.client.xml
+++ b/pom.client.xml
@@ -936,29 +936,29 @@
       <build>
         <plugins>
           <plugin>
-              <groupId>org.codehaus.mojo</groupId>
-              <artifactId>exec-maven-plugin</artifactId>
-              <version>1.2.1</version> <!-- {x-version-update;org.codehaus.mojo:exec-maven-plugin;external_dependency} -->
-              <executions>
-                  <execution>
-                      <id>generate-overview-from-readme</id>
-                      <phase>prepare-package</phase>
-                      <goals>
-                          <goal>exec</goal>
-                      </goals>
-                      <configuration>
-                        <executable>python</executable>
-                        <workingDirectory>${project.basedir}</workingDirectory>
-                        <arguments>
-                          <argument>../../../eng/pipelines/scripts/generate_overview_from_readme.py</argument>
-                          <argument>--rf</argument>
-                          <argument>${project.basedir}/README.md</argument>
-                          <argument>--v</argument>
-                          <argument>${project.version}</argument>
-                        </arguments>
-                      </configuration>
-                  </execution>
-              </executions>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>exec-maven-plugin</artifactId>
+            <version>1.2.1</version> <!-- {x-version-update;org.codehaus.mojo:exec-maven-plugin;external_dependency} -->
+            <executions>
+              <execution>
+                <id>generate-overview-from-readme</id>
+                <phase>prepare-package</phase>
+                <goals>
+                  <goal>exec</goal>
+                </goals>
+              </execution>
+            </executions>
+            <configuration>
+              <executable>python</executable>
+              <workingDirectory>${project.basedir}</workingDirectory>
+              <arguments>
+                <argument>../../../eng/pipelines/scripts/generate_overview_from_readme.py</argument>
+                <argument>--rf</argument>
+                <argument>${project.basedir}/README.md</argument>
+                <argument>--v</argument>
+                <argument>${project.version}</argument>
+              </arguments>
+            </configuration>
           </plugin>
           <!-- Add the overview argument to the javadoc args -->
           <plugin>
diff --git a/sdk/core/azure-core-test/src/samples/java/com/azure/core/test/ReadmeSamples.java b/sdk/core/azure-core-test/src/samples/java/com/azure/core/test/ReadmeSamples.java
index 0959b95820c6..3edada2f65de 100644
--- a/sdk/core/azure-core-test/src/samples/java/com/azure/core/test/ReadmeSamples.java
+++ b/sdk/core/azure-core-test/src/samples/java/com/azure/core/test/ReadmeSamples.java
@@ -34,7 +34,7 @@ public class SessionTests extends TestBase {
          * Use JUnit or TestNG annotation here for your testcase
          */
         public void fooTest() {
-            // Do some network service calls.
+            // Do some network calls.
         }
     }
 

From a14161bddab74f7e3363bcac14d4d73dcb2298f6 Mon Sep 17 00:00:00 2001
From: Srikanta <srnagar@microsoft.com>
Date: Tue, 3 Dec 2019 18:29:52 -0800
Subject: [PATCH 3/3] Separate profiles for Windows

---
 pom.client.xml | 81 ++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 78 insertions(+), 3 deletions(-)

diff --git a/pom.client.xml b/pom.client.xml
index 8f4b37063272..b6b02919cf18 100644
--- a/pom.client.xml
+++ b/pom.client.xml
@@ -973,6 +973,43 @@
       </build>
     </profile>
 
+    <profile>
+      <!-- separate profile for windows as the executable on windows is named npx.cmd and npx on other os families -->
+      <id>readme-codesnippet-windows</id>
+      <activation>
+        <property>
+          <name>readme-codesnippet-windows</name>
+        </property>
+      </activation>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>exec-maven-plugin</artifactId>
+            <version>1.2.1</version> <!-- {x-version-update;org.codehaus.mojo:exec-maven-plugin;external_dependency} -->
+            <executions>
+              <execution>
+                <id>code-snippet-for-readme-windows</id>
+                <phase>prepare-package</phase>
+                <goals>
+                  <goal>exec</goal>
+                </goals>
+                <configuration>
+                  <executable>npx.cmd</executable>
+                  <arguments>
+                    <argument>embedme</argument>
+                    <argument>sdk/*/azure-*/README.md</argument>
+                  </arguments>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+
+    <!-- Profiles for updating README file using embedme tool to inject code snippets from compilable Java source files.
+     Activate the profile below to update README files when corresponding Java files are updated. -->
     <profile>
       <id>readme-codesnippet</id>
       <activation>
@@ -997,7 +1034,43 @@
                   <executable>npx</executable>
                   <arguments>
                     <argument>embedme</argument>
-                    <argument>sdk/**/**/README.md</argument>
+                    <argument>sdk/*/azure-*/README.md</argument>
+                  </arguments>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+
+    <profile>
+      <!-- separate profile for windows as the executable on windows is named npx.cmd and npx on other os families -->
+      <id>verify-readme-windows</id>
+      <activation>
+        <os>
+          <family>windows</family>
+        </os>
+      </activation>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>exec-maven-plugin</artifactId>
+            <version>1.2.1</version> <!-- {x-version-update;org.codehaus.mojo:exec-maven-plugin;external_dependency} -->
+            <executions>
+              <execution>
+                <id>verify-readme-codesnippet-windows</id>
+                <phase>prepare-package</phase>
+                <goals>
+                  <goal>exec</goal>
+                </goals>
+                <configuration>
+                  <executable>npx.cmd</executable>
+                  <arguments>
+                    <argument>embedme</argument>
+                    <argument>--verify</argument>
+                    <argument>sdk/*/azure-*/README.md</argument>
                   </arguments>
                 </configuration>
               </execution>
@@ -1007,11 +1080,13 @@
       </build>
     </profile>
 
+    <!-- Verify that there are no changes to readme file. Build fails if the there's a difference in README
+     after running the embedme tool. -->
     <profile>
       <id>verify-readme</id>
       <activation>
         <os>
-          <family>unix</family>
+          <family>!windows</family>
         </os>
       </activation>
       <build>
@@ -1032,7 +1107,7 @@
                   <arguments>
                     <argument>embedme</argument>
                     <argument>--verify</argument>
-                    <argument>sdk/**/**/README.md</argument>
+                    <argument>sdk/*/azure-*/README.md</argument>
                   </arguments>
                 </configuration>
               </execution>