Merge pull request #804 from xamarin/mu-20231001-nuget-readme

[IMPROVEMENT] Nuget Readme included in the package
xamarin · Oct 30, 2023 · cae09fd · cae09fd
2 parents 5cbc1e3 + 0b1d2bb
commit cae09fd
Show file tree

Hide file tree

Showing 28 changed files with 494 additions and 13 deletions.
diff --git a/config.json b/config.json
@@ -22,6 +22,10 @@
       {
         "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
         "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
+      },
+      {
+        "templateFile": "source/GooglePlayServicesNuGetReadMe.cshtml",
+        "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
       }
     ],
     "artifacts": [
@@ -2738,6 +2742,10 @@
             "templateFile": "templates/glide/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2752,6 +2760,10 @@
             "templateFile": "templates/findbugs/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2766,6 +2778,10 @@
             "templateFile": "templates/chromium-cronet/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2780,6 +2796,10 @@
             "templateFile": "templates/tensorflow-lite/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2794,6 +2814,10 @@
             "templateFile": "templates/dagger/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2808,6 +2832,10 @@
             "templateFile": "templates/javax-inject/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2822,6 +2850,10 @@
             "templateFile": "templates/protobuf-lite/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2836,6 +2868,10 @@
             "templateFile": "templates/datatransport/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2850,6 +2886,10 @@
             "templateFile": "templates/user-messaging-platform/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2864,6 +2904,10 @@
             "templateFile": "templates/errorprone/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2879,18 +2923,8 @@
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
           {
-            "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
-            "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
-          }
-        ]
-      },
-      {
-        "name": "user-messaging-platform",
-        "mavenRepositoryType": "Google",
-        "templates": [
-          {
-            "templateFile": "templates/user-messaging-platform/Project.cshtml",
-            "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
           },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
@@ -2906,6 +2940,10 @@
             "templateFile": "templates/opencensus/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2920,6 +2958,10 @@
             "templateFile": "templates/perfmark/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2934,6 +2976,10 @@
             "templateFile": "templates/squareup-okhttp/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2948,6 +2994,10 @@
             "templateFile": "templates/squareup-okhttp3/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2962,6 +3012,10 @@
             "templateFile": "templates/squareup-picasso/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2976,6 +3030,10 @@
             "templateFile": "templates/squareup-retrofit/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -2990,6 +3048,10 @@
             "templateFile": "templates/squareup-retrofit2/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -3004,6 +3066,10 @@
             "templateFile": "templates/squareup-okio/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -3018,6 +3084,10 @@
             "templateFile": "templates/squareup-javapoet/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -3032,6 +3102,10 @@
             "templateFile": "templates/grpc/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -3046,6 +3120,10 @@
             "templateFile": "templates/codehaus-mojo/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -3060,6 +3138,10 @@
             "templateFile": "templates/zxing/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"
@@ -3074,6 +3156,10 @@
             "templateFile": "templates/flatbuffers/Project.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.csproj"
           },
+          {
+            "templateFile": "templates/NuGetReadMe.cshtml",
+            "outputFileRule": "generated/{groupid}.{artifactid}/readme.md"
+          },
           {
             "templateFile": "source/GooglePlayServicesSolutionFilter.cshtml",
             "outputFileRule": "generated/{groupid}.{artifactid}/{groupid}.{artifactid}.slnf"