docs: Weaviate v6 Go client — Go docs CI lane, tested go6 snippets (connect + CRUD), language tab#480
Draft
g-despot wants to merge 8 commits into
Draft
docs: Weaviate v6 Go client — Go docs CI lane, tested go6 snippets (connect + CRUD), language tab#480g-despot wants to merge 8 commits into
g-despot wants to merge 8 commits into
Conversation
…nguage tab Bootstraps CI for the Go client (previously zero Go docs coverage), scope-capped to a smoke set: connect, create-collection, insert, basic fetch. - _includes/code/go-v6/: new Go module with // START/// END-marked *_test.go snippets for the four smoke ops, plus main.go anchor and shared helpers. Committed go.mod requires a placeholder version with no replace; the client is not on the module proxy yet, so CI redirects it to a fresh clone. - .github/workflows/docs_tests.yml: new test-go job mirroring test-java (setup-go, clone + go mod edit -replace + go mod tidy, pytest -m go, same handle-test-results wiring), a go_client_branch dispatch input defaulting to the branch tip, and a GO_VERSION env. Ollama/Keycloak steps omitted (the smoke set needs neither embeddings nor OIDC). - tests/test_go.py + go marker in pytest.ini: pytest wrapper shelling go test. - src/theme/Tabs/index.js: go6 LANGUAGE_CONFIG entry plus a go6<->go family fallback so a global "Go v6" selection degrades to the Go tab instead of a dead panel. FilteredTextBlock.js gains a matching go6 DOC_SYSTEMS entry. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WmugebxuspdSQrFKE883W5
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 1 0 0 |
View in Orca |
☢️ The following Vulnerabilities (CVEs) have been detected
| PACKAGE | FILE | CVE ID | INSTALLED VERSION | FIXED VERSION | ||
|---|---|---|---|---|---|---|
|
google.golang.org/grpc | ...es/code/go-v6/go.mod | GHSA-hrxh-6v49-42gf | v1.81.1 | 1.82.1 | View in code |
…e 3a) Focused v6 Go client rollout: document the implemented surface with tested snippets, Coming-soon placeholders only where a touched page needs a go6 tab for a not-yet-implemented feature. Snippets (tested module _includes/code/go-v6/, mirrors the java-v6 lane): - connect_test.go: NewLocal, custom host+port, local API key, local + cloud third-party header keys, NewWeaviateCloud, OIDC bearer token. - manage_objects_test.go: Data.Insert (create), full Data.Replace (update), Data.Delete (by id), Data.DeleteSelected (delete-many by filter); placeholders for partial merge and fetch-by-id. - cross_references_test.go: Data.AddReferences (one-way); placeholders for cross-reference delete and update. Docs: - client-libraries/go.md: :::info Go client v6 admonition + "What changed in the v6 client" section (language-agnostic prose, no version numbers, no em dashes). - connections/connect-local, connect-cloud, oidc-connect include: go6 tabs. - manage-objects/create, update, delete, read; manage-collections/cross-references: go6 tabs. Validated locally with the CI replace injected: go mod tidy && go vet ./... && go build ./... && go test -run '^$' ./... all pass; committed go.mod keeps require-no-replace.
…oon panels, go tab highlight) - go.md: fix broken how-to link ../../guides.mdx -> ../guides.mdx (target is docs/weaviate/guides.mdx; matches sibling csharp.mdx). - go-v6 placeholders: move the TODO[g-despot] lines above the START markers in all 4 Coming-soon blocks (manage_objects_test.go UpdateMerge/ReadObject, cross_references_test.go Delete Go/Update Go) so the rendered Go v6 tab shows only "// Coming soon"; TODOs stay in-file and greppable (java-v6 convention). - connect-cloud.mdx: fix syntax highlighting on the two v5 Go tabs (language="py" -> "go" for APIKeyWCD and ThirdPartyAPIKeys). Validated: go vet ./... && go build ./... pass with CI replace injected; committed go.mod keeps require-no-replace. All 4 placeholder START..END regions confirmed to contain only "// Coming soon".
g-despot
changed the title
Add tested Go v6 snippets and parallel go/go6 tabs across the search and aggregate how-to pages, continuing the focused v6 rollout. Snippets (tested module _includes/code/go-v6/, compiled against v6 @f4fde3e): - search_basic_test.go: OverAll fetch variants (list, limit, offset, properties, vector, id, cross-refs, metadata, multi-tenancy). - search_test.go: NearText, NearVector, named-vector nearText, distance cutoff, limit/offset, autocut, group-by, filtered vector search. - hybrid_test.go: Hybrid basics, score, alpha, fusion, properties, property weighting, explicit vector, limit, autocut, filter. - filters_test.go: query/filter Cond/And/Or/Not, contains-any/all/none, like, reference-path, len, id/timestamp/null-state, near-text + filter. - aggregate_test.go: Aggregate.OverAll (count, text, integer, group-by) plus Aggregate.NearVector. - search_placeholders_test.go: Coming-soon placeholders (skip + marker) for near-object, geo filter, aggregation over near-text/hybrid, filtered aggregation. Docs: go6 tabs added beside the existing go tabs on search/basics, search/similarity, search/hybrid, search/filters, search/aggregate. Validated with the CI replace injected: go vet ./... && go build ./... && go test ./... -run '^$' all pass; committed go.mod keeps require-no-replace.
…arget (phase 3c)
Phase 3c of the Weaviate v6 Go client docs: add parallel "Go v6" (go6)
tabs beside the existing "Go" tabs for the fully-implemented management
APIs, backed by real, compile-verified snippets under
_includes/code/go-v6/.
Snippet files (package main, compile-only; runtime tests skip and stay
out of test_go.py's -run set):
- tenants_test.go multi-tenancy: MT config + auto-tenant, tenant
Create/Get(list)/Delete, tenant-scoped
insert/search/cross-ref
- rbac_test.go roles (create with each permission category,
add/remove permissions, exists/get/list/assigned
users/delete), DB + OIDC users, OIDC groups,
role->group assignments
- backup_test.go Create/Restore + Get*Status + Cancel* + await
helpers (AwaitCompletion / WithPollingInterval)
- aliases_test.go alias Create/List/Get/Update/Delete + use-in-query
- multi_target_test.go multi-target vectors: Sum/Min/Average/
ManualWeights/RelativeScore, Weighted, VectorName
Pages updated (63 go6 tabs total): multi-tenancy, collection-aliases,
rbac/manage-roles, rbac/manage-users, rbac/manage-groups, deploy backups,
search/multi-vector.
Two "// Coming soon" placeholders for ops the v6 client does not expose
yet: collection Update (UpdateAutoMT) and list-known-OIDC-groups
(GetKnownOidcGroups).
Verified: go vet ./... and go build ./... pass against the local v6
client via a temporary replace directive (dropped before commit);
go.mod/go.sum unchanged; gofmt clean.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WmugebxuspdSQrFKE883W5
…hase 3d) Add "Go v6" tabs only on config sections the v6 Go client actually implements: collection create/read/exists/list, properties + data types + tokenization + nested, named/multi vectors, model2vec + self-provided vectorizers, HFresh vector index, RQ compression, inverted index / BM25 / stopwords, sharding, and replication. Sections where v6 does not yet implement the operation (collection update/alter, add-property, add named vectors to existing, multi-vector embeddings, drop inverted index, PQ/BQ/SQ, non-model2vec vectorizers, generative/reranker config, enable-compression-on-existing) get no go6 tab and no placeholder; their existing go (v5) tab is left untouched. Snippets live in _includes/code/go-v6/ (manage_collections_test.go, vector_config_test.go, collection_config_test.go, compression_test.go), verified against the v6 source at /private/tmp/go-client-v6 with go vet ./... and go build ./... under a local replace directive. Config snippets t.Skip a live server and stay out of the CI -run set.
…s stay compile-only The test_manage_collections run pattern `TestCreateCollection` is an unanchored regex that now also matches the new compile-only config tests (TestCreateCollectionWithProperties / WithVectorizer / WithNamedVectors). Anchor it to `TestCreateCollection$` so the CI run-set is exactly the intended base smoke test; the new config tests stay out of the -run set and remain compile-only (mirrors how 3b/3c model-dependent tests are handled).
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Foundational documentation support for the new Weaviate v6 Go client (
github.com/weaviate/weaviate-go-client/v6), mirroring thejava-v6rollout: the CI lane + tested module + a parallelgo6language tab, plus the first slice of real v6 content (connect + object CRUD). Further increments (search, aggregate, collections config, tenants, RBAC, backup, aliases) will follow.CI + infrastructure
test-goCI job indocs_tests.yml(mirrorsTest Java): clones the go-client atgo_client_branch(defaultv6), injects a-replace, runs the Go snippet tests. Newgo_client_branchworkflow_dispatch input._includes/code/go-v6/— a tested Go module.go6"Go v6" language tab with ago6<->gofallback, so a global "Go v6" selection degrades to the v5 Go tab on pages without a v6 snippet.workflow_dispatchon this branch runs only the Go job (the other languages are skipped) to avoid cross-language noise while iterating;mainand the weekly schedule still run everything.Content (increment 3a)
client-libraries/go.md— v6 preview admonition + "What changed in the v6 client" section.connect-local,connect-cloud, OIDC include) and object CRUD (create/read/update/delete, cross-references) gaingo6tabs.go6tab rather than an empty panel.Pre-release note
The v6 client is pre-release (
v6.0.0-alpha.4) and not yet on the Go module proxy, sogo.modintentionally has noreplacedirective; CI injects it from a clone of thev6branch (mirroring the Java lane). Editors show import errors on the committed state; that is expected and resolves under the CI replace. Draft until more of the surface lands.Testing
The
test-golane passed in CI (4 smoke tests green against the live v6 client). Locally,go vet/go buildpass against the v6 source; the doc build + full live snippet run are covered by this PR's checks and the Go-only dispatch.