Skip to content

Add automated validation and issue creation for Go module coverage in registry#168

Draft
Copilot wants to merge 9 commits intomainfrom
copilot/check-go-module-entries
Draft

Add automated validation and issue creation for Go module coverage in registry#168
Copilot wants to merge 9 commits intomainfrom
copilot/check-go-module-entries

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Dec 26, 2025

Ensures all Go modules from testcontainers-go have corresponding entries in the community module registry.

Changes

  • Validation script (.github/scripts/check_go_modules.py)

    • Clones testcontainers-go and compares module lists against registry
    • Handles module name mappings (postgrespostgresql, gcloudgoogle-cloud, etc.)
    • Excludes utility modules (compose, socat) that don't represent standalone services
    • Reports missing modules or modules lacking Go documentation
    • Automatically creates GitHub issues in testcontainers-go repository for missing modules
    • Each issue includes step-by-step instructions, example templates, and documentation links
    • Checks for existing issues to prevent duplicates
  • CI integration (.github/workflows/ci.yml)

    • New check-go-modules job runs on every PR
    • Fails if Go modules are missing from registry
    • Provides GITHUB_TOKEN for automated issue creation
    • Includes issues: write permission
  • Documentation (README.md)

    • Added validation section with local execution instructions
    • Documented automated issue creation feature

Current Status

All 60 service modules from testcontainers-go are present in the registry. The check will catch future discrepancies automatically and create tracking issues with detailed instructions for contributors.

Run locally:

python3 .github/scripts/check_go_modules.py
Original prompt

Check that all Go module in https://golang.testcontainers.org/modules have an entry in this repo's module


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI self-assigned this Dec 26, 2025
Copilot AI and others added 5 commits December 26, 2025 23:08
Co-authored-by: mdelapenya <951580+mdelapenya@users.noreply.github.com>
Co-authored-by: mdelapenya <951580+mdelapenya@users.noreply.github.com>
…dirs with cleanup

Co-authored-by: mdelapenya <951580+mdelapenya@users.noreply.github.com>
Co-authored-by: mdelapenya <951580+mdelapenya@users.noreply.github.com>
Co-authored-by: mdelapenya <951580+mdelapenya@users.noreply.github.com>
Copilot AI changed the title [WIP] Verify Go module entries in repository Add automated validation for Go module coverage in registry Dec 26, 2025
Copilot AI requested a review from mdelapenya December 26, 2025 23:17
@mdelapenya
Copy link
Copy Markdown
Member

@copilot When the automation detects a missing module, create a GitHub issue in the Testcontainers-go repository with the cause, creating one issue per missing module. Include in the issue instructions on how to update the module in the website

Copilot AI and others added 3 commits January 22, 2026 07:34
Co-authored-by: mdelapenya <951580+mdelapenya@users.noreply.github.com>
… constants

Co-authored-by: mdelapenya <951580+mdelapenya@users.noreply.github.com>
Co-authored-by: mdelapenya <951580+mdelapenya@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jan 22, 2026

@copilot When the automation detects a missing module, create a GitHub issue in the Testcontainers-go repository with the cause, creating one issue per missing module. Include in the issue instruction...

Done! The validation script now automatically creates GitHub issues in the testcontainers-go repository when missing modules are detected. Each issue includes:

  • Step-by-step instructions for adding the module to the registry
  • Example index.md template with proper formatting
  • Documentation links and references

The script also checks for existing issues to prevent duplicates. See commit c5856be for the implementation.

Copilot AI changed the title Add automated validation for Go module coverage in registry Add automated validation and issue creation for Go module coverage in registry Jan 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants