Merge branch 'main' into feat/bump-max-buffer

Author: dylantientcheu

.github/workflows/go.yml

@@ -2,24 +2,23 @@ name: Go
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
-
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+      - uses: actions/checkout@v2
 
-    - name: Set up Go
-      uses: actions/setup-go@v2
-      with:
-        go-version: 1.19
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.19
 
-    - name: Build
-      run: go build -v ./...
+      - name: Build
+        run: go build -v ./...
 
-    - name: Test
-      run: go test -v ./...
+      - name: Test
+        run: go test -v ./...

.github/workflows/releases.yml

@@ -51,4 +51,6 @@ jobs:
           GIT_COMMITTER_EMAIL: [email protected]
           GIT_AUTHOR_EMAIL: [email protected]
           GITHUB_TOKEN: ${{ secrets.GORELEASER_GITHUB_TOKEN }}
-        run: make docs-pr
+        run: |
+          make docs-pr
+          make VARIATON=new docs-pr

Makefile

@@ -9,27 +9,42 @@ test:
 	go test ./... -p 1
 .PHONY: test
 
-## Build & publish the documentation
+## Build & publish the old documentation
+VARIATION ?= old
+ifeq ($(VARIATION),old)
+DOCS_FOLDER = docs
+DOCS_GENERATED_PATH = app_data/cli/commands
+DOCS_REPO_URL = https://github.com/algolia/doc.git
+DOCS_BRANCH = master
+DOCS_EXTENSION = yml
+else ifeq ($(VARIATION),new)
+DOCS_FOLDER = new-world-docs
+DOCS_GENERATED_PATH = apps/docs/content/pages/tools/cli/commands
+DOCS_REPO_URL = https://github.com/algolia/new-world-docs.git
+DOCS_BRANCH = main
+DOCS_EXTENSION = mdx
+endif
+
 docs:
-	git clone https://github.com/algolia/doc.git "$@"
+	git clone $(DOCS_REPO_URL) "$@"
 
 .PHONY: docs-commands-data
 docs-commands-data: docs
-	git -C docs pull
-	git -C docs checkout master
-	git -C docs rm 'app_data/cli/commands/*.yml' 2>/dev/null || true
-	go run ./cmd/docs --app_data-path docs/app_data/cli/commands
-	git -C docs add 'app_data/cli/commands/*.yml'
+	git -C $(DOCS_FOLDER) pull
+	git -C $(DOCS_FOLDER) checkout $(DOCS_BRANCH)
+	git -C $(DOCS_FOLDER) rm '$(DOCS_GENERATED_PATH)/*.$(DOCS_EXTENSION)' 2>/dev/null || true
+	go run ./cmd/docs --app_data-path $(DOCS_FOLDER)/$(DOCS_GENERATED_PATH) --target $(VARIATION)
+	git -C $(DOCS_FOLDER) add '$(DOCS_GENERATED_PATH)/*.$(DOCS_EXTENSION)'
 
 .PHONY: docs-pr
 docs-pr: docs-commands-data
 ifndef GITHUB_REF
 	$(error GITHUB_REF is not set)
 endif
-	git -C docs checkout -B feat/cli-'$(GITHUB_REF:refs/tags/v%=%)'
-	git -C docs commit -m 'feat: update cli commands data for $(GITHUB_REF:refs/tags/v%=%) version' || true
-	git -C docs push --set-upstream origin feat/cli-'$(GITHUB_REF:refs/tags/v%=%)'
-	cd docs; gh pr create -f -b "Changelog: https://github.com/algolia/cli/releases/tag/$(GITHUB_REF:refs/tags/v%=%)"
+	git -C $(DOCS_FOLDER) checkout -B feat/cli-'$(GITHUB_REF:refs/tags/v%=%)'
+	git -C $(DOCS_FOLDER) commit -m 'feat: update cli commands data for $(GITHUB_REF:refs/tags/v%=%) version' || true
+	git -C $(DOCS_FOLDER) push --set-upstream origin feat/cli-'$(GITHUB_REF:refs/tags/v%=%)'
+	cd $(DOCS_FOLDER); gh pr create -f -b "Changelog: https://github.com/algolia/cli/releases/tag/$(GITHUB_REF:refs/tags/%=%)"
 
 ## Create a new PR (or update the existing one) to update the API specs
 api-specs-pr:
@@ -62,4 +77,4 @@ install:
 # Uninstall Algolia CLI
 uninstall:
 	rm ${bindir}/algolia
-.PHONY: uninstall
+.PHONY: uninstall

README.md

@@ -4,8 +4,6 @@ A command line interface to enable Algolia developers to interact with and confi
 
 ![cli](https://user-images.githubusercontent.com/5702266/153008646-1fd8fbf2-4a4d-4421-b2f2-0886487f3e27.png)
 
-**Please note:** the Algolia CLI is in **beta** version and subject to the terms governing Beta Services. Algolia CLI may be subject to change or discontinued, and backwards-incompatible changes might be introduced in future releases.
-
 ## Documentation
 
 See the [documentation](https://algolia.com/doc/tools/cli/) for setup and usage instructions.