adk-docs
adk-docs copied to clipboard
PR and Regression testing for Go snippets
This PR introduces new tooling for managing and validating Go snippets within the repository.
Key additions include:
- Go Snippets Runner (
tools/go-snippets/runner.sh): A new script to build and run Go snippets, supporting both targeted execution for changed files and full regression testing. This script replaces the need for separatebuild_all.shandrun_all.shscripts. - Go Files to Test List (
tools/go-snippets/files_to_test.txt): A new configuration file that lists all Go snippet files to be included in the build and run processes. It supports single files and multiple files for packages with shared dependencies, and allows for comments. - Go Snippets PR Check (
tools/go-snippets/check_go_snippets.sh): A new script to ensure that all.gofiles in theexamples/godirectory are properly referenced infiles_to_test.txt, preventing new snippets from being overlooked in the test suite. - CI Workflow Integration: The
.github/workflows/go-snippets-pr-check.yamlworkflow utilizes these new scripts for comprehensive Go snippet testing on pull requests and a weekly schedule. These new files establish a robust and centralized system for Go snippet management, ensuring consistency and test coverage.