Go-SDK: Make go-sdk docs up to date with Coordinator change#68221
Merged
jason810496 merged 4 commits intoJun 9, 2026
Merged
Conversation
Expand GoDoc on the symbols a bundle author touches so the API teaches its own use: the sdk package overview and Client/Connection interfaces, and the bundlev1 BundleProvider, Registry, and Dag authoring surface (including the task-function injection and return-value contract). Also fixes a ConnectinNotFound typo in an example snippet.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Go Task SDK’s user-facing documentation (README and pkg.go.dev-visible Go doc comments) to reflect the newer “Coordinator” (executable bundle) execution model alongside the existing Edge Worker mode.
Changes:
- Expanded
go-sdk/README.mdwith a clearer explanation of bundles, Python stub DAGs, Coordinator vs Edge Worker deployment, and protocol details. - Improved GoDoc across the SDK and bundle registry APIs to better describe intended usage (narrow client interfaces, XCom behavior, bundle authoring entrypoints).
- Added a
just docshelper to preview rendered Go package docs locally via pkgsite.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| go-sdk/sdk/sdk.go | Adds/clarifies GoDoc for env-prefix constants and SDK client interfaces (Variables/Connections/XCom). |
| go-sdk/sdk/errors.go | Documents XComNotFound sentinel error for API 404/miss cases. |
| go-sdk/sdk/doc.go | Rewrites package-level docs with injected-client usage guidance and error semantics. |
| go-sdk/sdk/connection.go | Adds GoDoc describing Connection and GetURI() behavior. |
| go-sdk/sdk/client.go | Documents NewClient() and its intended (mostly test/advanced) usage. |
| go-sdk/README.md | Major rewrite to document Coordinator mode, bundle authoring, configuration, limitations, and protocols. |
| go-sdk/Justfile | Adds a docs recipe to serve pkg docs locally. |
| go-sdk/bundle/bundlev1/task.go | Documents NewTaskFunction wrapper/validation behavior. |
| go-sdk/bundle/bundlev1/schemas.go | Clarifies bundle authoring interfaces/types and their roles in the runtime. |
| go-sdk/bundle/bundlev1/registry.go | Adds detailed docs for registry/DAG/task registration and execution-time lookup. |
| go-sdk/bundle/bundlev1/bundlev1server/server.go | Documents ServerConfig as a forward-compatible options container. |
- Fix the AIRFLOW__SECTION__KEY env var template (double underscore) and reword the coordinator placement note in the README - Cross-link the formal executable-bundle-spec from the README - Move the env-prefix const docs onto per-constant comments so they satisfy Go doc conventions / revive - Pin the docs recipe's pkgsite to v0.1.0 for reproducible previews
1 task
- Correct "communication issues to the API server" -> "with" across the Variable/Connection/XCom NotFound sentinels - Make the bundle-spec link absolute so it resolves on pkg.go.dev, where relative cross-module paths break
jason810496
commented
Jun 8, 2026
kaxil
approved these changes
Jun 8, 2026
github-project-automation
Bot
moved this from In review
to Done
in AIP-72 (addendum): Go-SDK
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
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
The user-facing documentation changes for
go-sdk(Go API reference) documentation and thego-sdk/README.md(will show up in https://pkg.go.dev/github.com/apache/airflow/go-sdk after release).Verification
Checkout this feature branch then run
just docsundergo-sdkdirectory and navigate tolocalhost:6060to preview what the actual doc looks like.Was generative AI tooling used to co-author this PR?