Skip to content

chore: persist snippets on main #3929

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Oct 9, 2024
Merged

chore: persist snippets on main #3929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d96cd6d
chore: persist snippets on main
shortcuts Oct 8, 2024
b3c3305
chore: maybe this
shortcuts Oct 8, 2024
de939ca
chore: README.md
shortcuts Oct 8, 2024
40072eb
chore: workspacesg
shortcuts Oct 8, 2024
426ae44
fix swift and playground build
millotp Oct 9, 2024
890eb64
c#
millotp Oct 9, 2024
bbf106a
output to bundled
millotp Oct 9, 2024
9a358cc
build
millotp Oct 9, 2024
485e178
Merge branch 'main' into chore/persist-snippets-main
millotp Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,3 @@ pubspec.lock
swiftformat

foo

/snippets
13 changes: 4 additions & 9 deletions config/generation.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/**',
Expand All @@ -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/**',
Expand All @@ -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/**',
Expand Down Expand Up @@ -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/*',
Expand All @@ -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',

Expand Down
3 changes: 3 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
0 guides/python/requirements.txt → docs/bundled/monitoring-snippets.json
View file
Open in desktop
File renamed without changes.
0 guides/csharp/.config/dotnet-tools.json → ...snippets/csharp/.config/dotnet-tools.json
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions generators/src/main/java/com/algolia/codegen/cts/AlgoliaCTSGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion generators/src/main/java/com/algolia/codegen/cts/guides/GuidesGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
)
);
}
Expand Down
2 changes: 1 addition & 1 deletion generators/src/main/java/com/algolia/codegen/cts/manager/CSharpCTSManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"));
}
}
Expand Down
1 change: 0 additions & 1 deletion generators/src/main/java/com/algolia/codegen/cts/manager/GoCTSManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"));
}
}
4 changes: 2 additions & 2 deletions generators/src/main/java/com/algolia/codegen/cts/manager/SwiftCTSManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"));
}
}
Expand Down
2 changes: 1 addition & 1 deletion generators/src/main/java/com/algolia/codegen/cts/tests/SnippetsGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
)
);
}
Expand Down
Loading
Loading