docs: document go sdk with examples #15069
Open
Conversation
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
Joibel
force-pushed
the
gosdk
branch
2 times, most recently
from
334dda0 to
605ff9f
Compare
Copilot finished reviewing on behalf of
Joibel
November 24, 2025 13:27
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation and examples for the Argo Workflows Go SDK, making it easier for developers to get started with the SDK.
Key Changes
- Added 5 working Go SDK examples with tests (basic-workflow, watch-workflow, workflow-template, grpc-client, alternate_auth)
- Integrated snipdoc for including tested code snippets in documentation
- Added comprehensive README files for each example covering setup, usage, and best practices
- Updated CI/CD to test the Go SDK examples
Reviewed changes
Copilot reviewed 26 out of 31 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| snipdoc-config.yml | Configuration for snipdoc tool to extract code snippets from examples |
| sdks/go/*/go.mod | Go module files for each example (contains invalid Go version) |
| sdks/go/*/main.go | Example implementations for various SDK usage patterns |
| sdks/go/*/README.md | Documentation for each example with usage instructions |
| sdks/CONTRIBUTING.md | Minor wording update for SDK contributions |
| mkdocs.yml | Added go-sdk-guide.md to documentation navigation |
| .spelling | Added gRPC and kubeconfig to spelling allowlist |
| .github/workflows/ci-build.yaml | Added test-go-sdk job to CI pipeline |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Joibel
force-pushed
the
gosdk
branch
3 times, most recently
from
63332a9 to
f735a6a
Compare
Signed-off-by: Alan Clucas <[email protected]>
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.
Motivation
People use the GO SDK but it's very sparsely documented. Lets make the on-ramp slightly easier for this with a full documentation page about it and some examples
Modifications
Added some (tested) examples which also (except for the difficult to run auth tests) run as tests also to prove they're not very broken.
Introduced snipdoc so that the docs page actually includes tested code from the examples.
Moved kubernetes client config from non-standard
.kubeconfigto.kube/configas this is where the examples expect it.Verification
See above, new test suite.
Documentation
This is principally new documentation.
Re-did the client-libraries page to make it a bit more verbose in anticipation of this being a more worked on area.