chore: persist snippets on main (#3929)

Co-authored-by: Pierre Millot <[email protected]>

Author: shortcuts

.gitignore

@@ -58,5 +58,3 @@ pubspec.lock
 swiftformat
 
 foo
-
-/snippets

config/generation.config.mjs

@@ -4,7 +4,10 @@ export const patterns = [
   'specs/bundled/*.json',
 
   'clients/**',
-  'guides/**',
+  'docs/**',
+  'docs/**/.*',
+  'docs/**/.*/**',
+  '!docs/README.md',
   '!clients/README.md',
   '!clients/**/.openapi-generator-ignore',
   'clients/**/.github/**',
@@ -22,8 +25,6 @@ export const patterns = [
   '!clients/algoliasearch-client-csharp/algoliasearch/Models/Common/**',
 
   'tests/output/csharp/global.json',
-  'guides/csharp/.config/**',
-  'guides/csharp/.gitignore',
 
   // Dart
   '!clients/algoliasearch-client-dart/**',
@@ -49,7 +50,6 @@ export const patterns = [
   '!clients/algoliasearch-client-go/algolia/utils/*',
 
   '!tests/output/go/go.*',
-  'guides/go/.golangci.yml',
 
   // Java
   '!clients/algoliasearch-client-java/**',
@@ -136,9 +136,6 @@ export const patterns = [
   '!clients/algoliasearch-client-scala/src/main/scala/algoliasearch/config/**',
   '!clients/algoliasearch-client-scala/src/main/scala/algoliasearch/extension/**',
 
-  'guides/scala/.scalafmt.conf',
-  'guides/scala/.gitignore',
-
   // Swift
   'clients/algoliasearch-client-swift/**',
   '!clients/algoliasearch-client-swift/*',
@@ -154,8 +151,6 @@ export const patterns = [
   'tests/output/swift/Package.swift',
   '!tests/output/swift/manual/**',
   '!tests/output/swift/Utils/**',
-  'guides/.gitignore',
-  'guides/swift/.swiftformat',
 
   'clients/**/LICENSE',
 

docs/README.md

@@ -0,0 +1,3 @@
+## docs
+
+This folder contains generated code snippets and guides for the API clients, you can see them used on [the Algolia documentation](https://www.algolia.com/doc/libraries)

guides/python/requirements.txt renamed to docs/bundled/monitoring-snippets.json

@@ -63,11 +63,11 @@ public void processOpts() {
       testsGenerators.add(new TestsClient(ctsManager, true));
       testsGenerators.add(new TestsClient(ctsManager, false));
     } else if (mode.equals("snippets")) {
-      ctsManager.addSnippetsSupportingFiles(supportingFiles, mode);
+      ctsManager.addSnippetsSupportingFiles(supportingFiles, "docs/" + mode);
 
       testsGenerators.add(new SnippetsGenerator(ctsManager));
     } else if (mode.equals("guides")) {
-      ctsManager.addSnippetsSupportingFiles(supportingFiles, mode);
+      ctsManager.addSnippetsSupportingFiles(supportingFiles, "docs/" + mode);
 
       testsGenerators.add(new GuidesGenerator(ctsManager));
     } else {

guides/csharp/.config/dotnet-tools.json renamed to docs/snippets/csharp/.config/dotnet-tools.json

@@ -42,7 +42,7 @@ public void addSupportingFiles(List<SupportingFile> supportingFiles, String outp
       supportingFiles.add(
         new SupportingFile(
           "guides/" + client + "/" + f.getName(),
-          "guides/" + language + outputFolder + f.getName().replace(".mustache", "") + extension
+          "docs/guides/" + language + outputFolder + f.getName().replace(".mustache", "") + extension
         )
       );
     }

generators/src/main/java/com/algolia/codegen/cts/AlgoliaCTSGenerator.java

@@ -33,7 +33,7 @@ public void addSnippetsSupportingFiles(List<SupportingFile> supportingFiles, Str
     supportingFiles.add(new SupportingFile("snippets/Algolia.mustache", output + "/csharp/Algolia.sln"));
     supportingFiles.add(new SupportingFile("snippets/dotnet-tools.mustache", output + "/csharp/.config/dotnet-tools.json"));
 
-    if (output.equals("snippets")) {
+    if (output.equals("docs/snippets")) {
       supportingFiles.add(new SupportingFile("snippets/Program.mustache", output + "/csharp/src/Program.cs"));
     }
   }

generators/src/main/java/com/algolia/codegen/cts/guides/GuidesGenerator.java

@@ -37,6 +37,5 @@ public void addDataToBundle(Map<String, Object> bundle) throws GeneratorExceptio
   public void addSnippetsSupportingFiles(List<SupportingFile> supportingFiles, String output) {
     supportingFiles.add(new SupportingFile("snippets/.golangci.mustache", output + "/go/.golangci.yml"));
     supportingFiles.add(new SupportingFile("snippets/go.mod.mustache", output + "/go/go.mod"));
-    supportingFiles.add(new SupportingFile("snippets/go.sum.mustache", output + "/go/go.sum"));
   }
 }

generators/src/main/java/com/algolia/codegen/cts/manager/CSharpCTSManager.java

@@ -45,9 +45,9 @@ public void addSnippetsSupportingFiles(List<SupportingFile> supportingFiles, Str
     supportingFiles.add(new SupportingFile("snippets/.swiftformat.mustache", output + "/swift", ".swiftformat"));
     supportingFiles.add(new SupportingFile("snippets/.gitignore.mustache", output + "/swift", ".gitignore"));
 
-    if (output.equals("snippets")) {
+    if (output.equals("docs/snippets")) {
       supportingFiles.add(new SupportingFile("snippets/Package.mustache", output + "/swift", "Package.swift"));
-    } else if (output.equals("guides")) {
+    } else if (output.equals("docs/guides")) {
       supportingFiles.add(new SupportingFile("guides/Package.mustache", output + "/swift", "Package.swift"));
     }
   }

generators/src/main/java/com/algolia/codegen/cts/manager/GoCTSManager.java

@@ -39,7 +39,7 @@ public void addSupportingFiles(List<SupportingFile> supportingFiles, String outp
     supportingFiles.add(
       new SupportingFile(
         "snippets/method.mustache",
-        "snippets/" + language + outputFolder + Helpers.createClientName(client, language) + extension
+        "docs/snippets/" + language + outputFolder + Helpers.createClientName(client, language) + extension
       )
     );
   }