feat(clients): generate code snippets from cts #2511
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for api-clients-automation ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
shortcuts
force-pushed
the
feat/code-snippets-from-cts
branch
from
d1ccc0e
to
fb026e9
Compare
shortcuts
force-pushed
the
feat/code-snippets-from-cts
branch
from
a6b7144
to
74bbf79
Compare
millotp
reviewed
Jan 10, 2024
generators/src/main/java/com/algolia/codegen/cts/AlgoliaCTSGenerator.java
Outdated
Show resolved
Hide resolved
| @@ -43,6 +43,9 @@ export async function ctsGenerateMany(generators: Generator[]): Promise<void> { | |||
| await run('YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install', { | |||
| cwd: 'tests/output/javascript', | |||
| }); | |||
| await run('YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install', { | |||
There was a problem hiding this comment.
I think this should be in a totally different file, like scripts/snippets/generate.ts
There was a problem hiding this comment.
I did not yet created the CLI stuff, I know you want to do it :D
millotp
approved these changes
Jan 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧭 What and Why
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/DI-1749
Changes included:
This PR registers a new generator in order to generate code snippets for each method of each languages, it is completely based on the CTS request generator and will take the first test case of each method as the example.
The snippets are generated for
Generators change
I had to change the output folder and template dir in order to fully reuse the
TestsRequestgenerator, which means each template has been edited to include thetestsfolder when using partial templatesclients.config.json
A new field named
snippetsallows us to store the output folder and the file extension, similarly to what we do for testsCI
We now store the snippets in the artifacts and restore them in order to be pushed by the CI
What's next