feat: upgrade the CLI to use the Go API client version 4 #176
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
kai687
force-pushed
the
feat/v4
branch
2 times, most recently
from
80e2188 to
9d9dfb1
Compare
Adds devbox for easy environment management. In combination with `direnv`, the env is started automatically. Without `direnv`, just do `devbox shell`. Running Make as a task runner is phony. A Taskfile is better suited for this.
With gofumpt and golines for more readability
Copying the binary into the Docker container doesn't work if the host CPU architecture is different (like an M1 mac). Since it's quick to build, we can just build the CLI inside Docker.
This commit also re-enables support for the `--wait` flag, which was commented out.
This commit gets rid of some custom validation code. We don't have to validate the multiple-batch request body in the CLI, since that is done in the v4 API client now. This commit also adds support for the 'delete index' and 'clear objects' actions.
Shows an outdated logo and has fulfilled it's gimmicky purpose.
For some commands, it was already implemented, but not for all commands. Having the option to wait until the (async) operation is done on Algolia's servers makes it possible to run automatic tests for the commands.
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.
This PR migrates the Algolia CLI to use version 4 of the Algolia Go API client.
Features
All commands and glue code use the latest major version of the Algolia Go API client.
Improvements on top of that
algolia settings importcommand now has support for--forward-to-replicasjust likealgolia settings setalgolia objects operationscommand now supports theclearanddeleteIndexactions as well (this makes theoperationscommand support all batch operations).algolia rules browsenow returns an error if an index doesn't existalgolia synonyms browsenow returns an error if an index doesn't exist--waitflag:algolia indices clearalgolia indices deletealgolia objects deletealgolia objects importalgolia rules deletealgolia rules importalgolia settings importalgolia settings setalgolia synonyms deletealgolia synonyms importalgolia synonyms save--includeReplicasoption to--include-replicasfor thealgolia indices deletecommand to be in line with other CLI optionsrecordsforobjectslistforbrowseBugfixes
algolia indices copycommand has support again for the--waitflagalgolia events tailnow works with newer profile files (that haveapi_keyinstead ofadmin_api_keystoredImprovements for developers
gosec,gofumpt, andstylechecklinters for more consistency and safety (fixed some potential issues thanks of that)Taskfile.ymlinstead of Makefile. Allows for better discoverability (task -l), documentation (each task can have descriptions), and cleaner syntax (no .PHONY build targets as tasks, handling of variables)devbox.jsonfile (Devbox and direnv are great in combination)