chore(clients): add workflow to auto-close PR (#3834)

shortcuts · web-flow · commit 78848353790f · 2024-09-26T15:48:47.000Z
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaCSharpGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaCSharpGenerator.java
@@ -121,9 +121,7 @@ public void processOpts() {
     supportingFiles.add(new SupportingFile("netcore_project.mustache", "Algolia.Search.csproj"));
     supportingFiles.add(new SupportingFile("Configuration.mustache", "Clients", packageName + "Configuration.cs"));
 
-    supportingFiles.add(new SupportingFile("LICENSE", "../", "LICENSE"));
-    supportingFiles.add(new SupportingFile("issue.yml", "../.github/workflows", "issue.yml"));
-    supportingFiles.add(new SupportingFile("Bug_report.yml", "../.github/ISSUE_TEMPLATE", "Bug_report.yml"));
+    Helpers.addCommonSupportingFiles(supportingFiles, "../");
 
     reservedWords.removeIf(word -> word.equals("Configuration"));
   }
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaDartGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaDartGenerator.java
@@ -100,10 +100,9 @@ public void processOpts() {
 
     supportingFiles.add(new SupportingFile("version.mustache", srcFolder, "version.dart"));
     supportingFiles.add(new SupportingFile("LICENSE", "", "LICENSE"));
-
     supportingFiles.add(new SupportingFile("LICENSE", "../client_core/", "LICENSE"));
-    supportingFiles.add(new SupportingFile("issue.yml", "../../.github/workflows", "issue.yml"));
-    supportingFiles.add(new SupportingFile("Bug_report.yml", "../../.github/ISSUE_TEMPLATE", "Bug_report.yml"));
+
+    Helpers.addCommonSupportingFiles(supportingFiles, "../../");
 
     // Search config
     additionalProperties.put("isSearchClient", client.equals("search"));
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaGoGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaGoGenerator.java
@@ -54,9 +54,7 @@ public void processOpts() {
     supportingFiles.add(new SupportingFile("configuration.mustache", "", "configuration.go"));
     supportingFiles.add(new SupportingFile("client.mustache", "", "client.go"));
 
-    supportingFiles.add(new SupportingFile("LICENSE", "../../", "LICENSE"));
-    supportingFiles.add(new SupportingFile("issue.yml", "../../.github/workflows", "issue.yml"));
-    supportingFiles.add(new SupportingFile("Bug_report.yml", "../../.github/ISSUE_TEMPLATE", "Bug_report.yml"));
+    Helpers.addCommonSupportingFiles(supportingFiles, "../../");
 
     try {
       additionalProperties.put("packageVersion", Helpers.getClientConfigField("go", "packageVersion"));
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java
@@ -55,9 +55,7 @@ public void processOpts() {
     supportingFiles.add(new SupportingFile("gradle.properties.mustache", "", "gradle.properties"));
     additionalProperties.put("isSearchClient", client.equals("search"));
 
-    supportingFiles.add(new SupportingFile("LICENSE", "", "LICENSE"));
-    supportingFiles.add(new SupportingFile("issue.yml", ".github/workflows", "issue.yml"));
-    supportingFiles.add(new SupportingFile("Bug_report.yml", ".github/ISSUE_TEMPLATE", "Bug_report.yml"));
+    Helpers.addCommonSupportingFiles(supportingFiles, "");
 
     reservedWords.removeIf(word -> word.equals("configuration"));
 
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java
@@ -59,11 +59,9 @@ public void processOpts() {
     // root export files
     supportingFiles.add(new SupportingFile("index.mustache", "", "index.js"));
     supportingFiles.add(new SupportingFile("index.d.mustache", "", "index.d.ts"));
-
     supportingFiles.add(new SupportingFile("LICENSE", "", "LICENSE"));
-    supportingFiles.add(new SupportingFile("LICENSE", "", "../../LICENSE"));
-    supportingFiles.add(new SupportingFile("issue.yml", "../../.github/workflows", "issue.yml"));
-    supportingFiles.add(new SupportingFile("Bug_report.yml", "../../.github/ISSUE_TEMPLATE", "Bug_report.yml"));
+
+    Helpers.addCommonSupportingFiles(supportingFiles, "../../");
 
     supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
 
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaKotlinGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaKotlinGenerator.java
@@ -112,9 +112,7 @@ public void processOpts() {
     supportingFiles.add(new SupportingFile("gradle.properties.mustache", "", "gradle.properties"));
     supportingFiles.add(new SupportingFile("README_BOM.mustache", "client-bom", "README.md"));
 
-    supportingFiles.add(new SupportingFile("LICENSE", "", "LICENSE"));
-    supportingFiles.add(new SupportingFile("issue.yml", ".github/workflows", "issue.yml"));
-    supportingFiles.add(new SupportingFile("Bug_report.yml", ".github/ISSUE_TEMPLATE", "Bug_report.yml"));
+    Helpers.addCommonSupportingFiles(supportingFiles, "");
 
     additionalProperties.put("packageVersion", Helpers.getClientConfigField("kotlin", "packageVersion"));
   }
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaPhpGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaPhpGenerator.java
@@ -51,9 +51,7 @@ public void processOpts() {
     supportingFiles.add(new SupportingFile("client_config.mustache", "lib/Configuration", getClientName(client) + "Config.php"));
     supportingFiles.add(new SupportingFile("Algolia.mustache", "lib", "Algolia.php"));
 
-    supportingFiles.add(new SupportingFile("LICENSE", "", "LICENSE"));
-    supportingFiles.add(new SupportingFile("issue.yml", ".github/workflows", "issue.yml"));
-    supportingFiles.add(new SupportingFile("Bug_report.yml", ".github/ISSUE_TEMPLATE", "Bug_report.yml"));
+    Helpers.addCommonSupportingFiles(supportingFiles, "");
 
     additionalProperties.put("isSearchClient", client.equals("search"));
     additionalProperties.put("configClassname", getClientName(client) + "Config");
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaPythonGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaPythonGenerator.java
@@ -87,9 +87,7 @@ public void processOpts() {
     supportingFiles.add(new SupportingFile("__init__.mustache", "http", "__init__.py"));
     supportingFiles.add(new SupportingFile("config.mustache", packageName, "config.py"));
 
-    supportingFiles.add(new SupportingFile("LICENSE", "../", "LICENSE"));
-    supportingFiles.add(new SupportingFile("issue.yml", "../.github/workflows", "issue.yml"));
-    supportingFiles.add(new SupportingFile("Bug_report.yml", "../.github/ISSUE_TEMPLATE", "Bug_report.yml"));
+    Helpers.addCommonSupportingFiles(supportingFiles, "../");
   }
 
   @Override
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaRubyGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaRubyGenerator.java
@@ -42,9 +42,7 @@ public void processOpts() {
     apiTestTemplateFiles.clear();
     modelTestTemplateFiles.clear();
 
-    supportingFiles.add(new SupportingFile("LICENSE", "", "LICENSE"));
-    supportingFiles.add(new SupportingFile("issue.yml", ".github/workflows", "issue.yml"));
-    supportingFiles.add(new SupportingFile("Bug_report.yml", ".github/ISSUE_TEMPLATE", "Bug_report.yml"));
+    Helpers.addCommonSupportingFiles(supportingFiles, "");
 
     // Remove some files we don't want to output or change their paths
     supportingFiles.removeIf(
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaScalaGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaScalaGenerator.java
@@ -75,9 +75,7 @@ public void processOpts() {
     supportingFiles.add(new SupportingFile("version.mustache", "", "version.sbt"));
     supportingFiles.add(new SupportingFile("jsonSupport.mustache", modelFolder, "JsonSupport.scala"));
 
-    supportingFiles.add(new SupportingFile("LICENSE", "", "LICENSE"));
-    supportingFiles.add(new SupportingFile("issue.yml", ".github/workflows", "issue.yml"));
-    supportingFiles.add(new SupportingFile("Bug_report.yml", ".github/ISSUE_TEMPLATE", "Bug_report.yml"));
+    Helpers.addCommonSupportingFiles(supportingFiles, "");
 
     additionalProperties.put("isSearchClient", client.equals("search"));
     typeMapping.put("AnyType", "Any");
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaSwiftGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaSwiftGenerator.java
@@ -197,9 +197,7 @@ public void processOpts() {
     supportingFiles.add(
       new SupportingFile("client_configuration.mustache", sourceFolder, getClientName(CLIENT) + "ClientConfiguration.swift")
     );
-    supportingFiles.add(new SupportingFile("LICENSE", "", "LICENSE"));
-    supportingFiles.add(new SupportingFile("issue.yml", ".github/workflows", "issue.yml"));
-    supportingFiles.add(new SupportingFile("Bug_report.yml", ".github/ISSUE_TEMPLATE", "Bug_report.yml"));
+    Helpers.addCommonSupportingFiles(supportingFiles, "");
 
     supportingFiles.add(new SupportingFile("Package.mustache", "Package.swift"));
     supportingFiles.add(new SupportingFile("podspec.mustache", projectName + ".podspec"));
diff --git a/generators/src/main/java/com/algolia/codegen/utils/Helpers.java b/generators/src/main/java/com/algolia/codegen/utils/Helpers.java
@@ -14,6 +14,7 @@
 import org.openapitools.codegen.CodegenOperation;
 import org.openapitools.codegen.CodegenServer;
 import org.openapitools.codegen.CodegenServerVariable;
+import org.openapitools.codegen.SupportingFile;
 import org.openapitools.codegen.model.OperationsMap;
 
 public class Helpers {
@@ -258,6 +259,15 @@ public static void prettyPrint(Object o) {
     Json.prettyPrint(o);
   }
 
+  public static void addCommonSupportingFiles(List<SupportingFile> supportingFiles, String root) {
+    supportingFiles.add(new SupportingFile("LICENSE", "", root + "LICENSE"));
+    supportingFiles.add(new SupportingFile("issue.yml", root + ".github/workflows", "issue.yml"));
+    supportingFiles.add(new SupportingFile("Bug_report.yml", root + ".github/ISSUE_TEMPLATE", "Bug_report.yml"));
+    supportingFiles.add(
+      new SupportingFile("do-not-edit-this-repository.yml", root + ".github/workflows", "do-not-edit-this-repository.yml")
+    );
+  }
+
   public static String getLanguageVersion(String language) throws IOException {
     String versionFile = language.equals("javascript")
       ? ".nvmrc"
diff --git a/templates/csharp/do-not-edit-this-repository.yml b/templates/csharp/do-not-edit-this-repository.yml
@@ -0,0 +1 @@
+../do-not-edit-this-repository.yml
diff --git a/templates/dart/do-not-edit-this-repository.yml b/templates/dart/do-not-edit-this-repository.yml
@@ -0,0 +1 @@
+../do-not-edit-this-repository.yml
diff --git a/templates/do-not-edit-this-repository.yml b/templates/do-not-edit-this-repository.yml
@@ -0,0 +1,24 @@
+name: Do not edit files in this repository
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopen
+    branches:
+      - 'main'
+
+jobs:
+  auto_close_pr:
+    name: Close PR
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Close PR
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+        run: |
+          gh pr close "${PR_NUMBER}" -d -c "Thanks for contributing to our API clients! Sorry to close your PR, but this repository is fully generated, you can port your changes to [the API Clients Automation repository](https://github.com/algolia/api-clients-automation). If you need some guidance, feel free to [open an issue](https://github.com/algolia/api-clients-automation/issues) or [read our contribution guide](https://api-clients-automation.netlify.app/docs/introduction)."
diff --git a/templates/go/do-not-edit-this-repository.yml b/templates/go/do-not-edit-this-repository.yml
@@ -0,0 +1 @@
+../do-not-edit-this-repository.yml
diff --git a/templates/java/do-not-edit-this-repository.yml b/templates/java/do-not-edit-this-repository.yml
@@ -0,0 +1 @@
+../do-not-edit-this-repository.yml
diff --git a/templates/javascript/clients/do-not-edit-this-repository.yml b/templates/javascript/clients/do-not-edit-this-repository.yml
@@ -0,0 +1 @@
+../../do-not-edit-this-repository.yml
diff --git a/templates/kotlin/do-not-edit-this-repository.yml b/templates/kotlin/do-not-edit-this-repository.yml
@@ -0,0 +1 @@
+../do-not-edit-this-repository.yml
diff --git a/templates/php/do-not-edit-this-repository.yml b/templates/php/do-not-edit-this-repository.yml
@@ -0,0 +1 @@
+../do-not-edit-this-repository.yml
diff --git a/templates/python/do-not-edit-this-repository.yml b/templates/python/do-not-edit-this-repository.yml
@@ -0,0 +1 @@
+../do-not-edit-this-repository.yml
diff --git a/templates/ruby/do-not-edit-this-repository.yml b/templates/ruby/do-not-edit-this-repository.yml
@@ -0,0 +1 @@
+../do-not-edit-this-repository.yml
diff --git a/templates/scala/do-not-edit-this-repository.yml b/templates/scala/do-not-edit-this-repository.yml
@@ -0,0 +1 @@
+../do-not-edit-this-repository.yml
diff --git a/templates/swift/do-not-edit-this-repository.yml b/templates/swift/do-not-edit-this-repository.yml
@@ -0,0 +1 @@
+../do-not-edit-this-repository.yml

Original file line number	Diff line number	Diff line change
`@@ -121,9 +121,7 @@ public void processOpts() {`
`121`	`121`	`supportingFiles.add(new SupportingFile("netcore_project.mustache", "Algolia.Search.csproj"));`
`122`	`122`	`supportingFiles.add(new SupportingFile("Configuration.mustache", "Clients", packageName + "Configuration.cs"));`
`123`	`123`
`124`		`- supportingFiles.add(new SupportingFile("LICENSE", "../", "LICENSE"));`
`125`		`- supportingFiles.add(new SupportingFile("issue.yml", "../.github/workflows", "issue.yml"));`
`126`		`- supportingFiles.add(new SupportingFile("Bug_report.yml", "../.github/ISSUE_TEMPLATE", "Bug_report.yml"));`
	`124`	`+ Helpers.addCommonSupportingFiles(supportingFiles, "../");`
`127`	`125`
`128`	`126`	`reservedWords.removeIf(word -> word.equals("Configuration"));`
`129`	`127`	`}`
Original file line number	Diff line number	Diff line change
`@@ -112,9 +112,7 @@ public void processOpts() {`
`112`	`112`	`supportingFiles.add(new SupportingFile("gradle.properties.mustache", "", "gradle.properties"));`
`113`	`113`	`supportingFiles.add(new SupportingFile("README_BOM.mustache", "client-bom", "README.md"));`
`114`	`114`
`115`		`- supportingFiles.add(new SupportingFile("LICENSE", "", "LICENSE"));`
`116`		`- supportingFiles.add(new SupportingFile("issue.yml", ".github/workflows", "issue.yml"));`
`117`		`- supportingFiles.add(new SupportingFile("Bug_report.yml", ".github/ISSUE_TEMPLATE", "Bug_report.yml"));`
	`115`	`+ Helpers.addCommonSupportingFiles(supportingFiles, "");`
`118`	`116`
`119`	`117`	`additionalProperties.put("packageVersion", Helpers.getClientConfigField("kotlin", "packageVersion"));`
`120`	`118`	`}`
Original file line number	Diff line number	Diff line change
`@@ -87,9 +87,7 @@ public void processOpts() {`
`87`	`87`	`supportingFiles.add(new SupportingFile("__init__.mustache", "http", "__init__.py"));`
`88`	`88`	`supportingFiles.add(new SupportingFile("config.mustache", packageName, "config.py"));`
`89`	`89`
`90`		`- supportingFiles.add(new SupportingFile("LICENSE", "../", "LICENSE"));`
`91`		`- supportingFiles.add(new SupportingFile("issue.yml", "../.github/workflows", "issue.yml"));`
`92`		`- supportingFiles.add(new SupportingFile("Bug_report.yml", "../.github/ISSUE_TEMPLATE", "Bug_report.yml"));`
	`90`	`+ Helpers.addCommonSupportingFiles(supportingFiles, "../");`
`93`	`91`	`}`
`94`	`92`
`95`	`93`	`@Override`