Merge branch 'main' into pre-creation-hook

* main:
  Add toxiproxy example (testcontainers#643)
  Add spanner example (testcontainers#642)
  chore: sync governance files (testcontainers#641)
  Add pubsub example (testcontainers#640)
  chore: adjust generator for the docs site (testcontainers#639)
  Add datastore example (testcontainers#638)
  Add firestore example (#637)
  fix: avoid panics when checking container state and container.raw is nil (#635)
  feat: provide a tool to generate examples from code (#618)
  chore: bump version in mkdocs (#630)
  docs: remove code snippets from main README (#631)
  docs: document replace directive for Docker Compose (#632)

.github/settings.yml

@@ -135,6 +135,8 @@ collaborators:
     permission: maintain
   - username: mdelapenya
     permission: admin
+  - username: testcontainersbot
+    permission: write
 
   # Note: `permission` is only valid on organization-owned repositories.
   # The permission to grant the collaborator. Can be one of:

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
         run: go mod verify
 
       - name: modTidy
-        run: go mod tidy
+        run: make tools-tidy
 
       - name: ensure compilation
         env:
@@ -43,6 +43,10 @@ jobs:
         if: ${{ matrix.platform == 'ubuntu-latest' }}
         run: make -C e2e tools-tidy
 
+      - name: Run example generator tests
+        if: ${{ matrix.platform == 'ubuntu-latest' }}
+        run: make -C examples test-unit
+
       - name: Run e2e tests
         if: ${{ matrix.platform == 'ubuntu-latest' }}
         run: make test-e2e

.github/workflows/cockroachdb-example.yml

@@ -0,0 +1,42 @@
+name: Cockroachdb example pipeline
+
+on: [push, pull_request]
+
+jobs:
+  test-cockroachdb:
+    strategy:
+      matrix:
+        go-version: [1.18.x, 1.x]
+    runs-on: "ubuntu-latest"
+    steps:
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: modVerify
+        working-directory: ./examples/cockroachdb
+        run: go mod verify
+
+      - name: modTidy
+        working-directory: ./examples/cockroachdb
+        run: make tools-tidy
+
+      - name: gotestsum
+        working-directory: ./examples/cockroachdb
+        run: make test-unit
+
+      - name: Run checker
+        run: |
+          ./scripts/check_environment.sh
+
+      - name: Test Summary
+        uses: test-summary/action@4ee9ece4bca777a38f05c8fc578ac2007fe266f7
+        with:
+          paths: "**/TEST-cockroachdb*.xml"
+        if: always()

.github/workflows/datastore-example.yml

@@ -0,0 +1,42 @@
+name: Datastore example pipeline
+
+on: [push, pull_request]
+
+jobs:
+  test-datastore:
+    strategy:
+      matrix:
+        go-version: [1.18.x, 1.x]
+    runs-on: "ubuntu-latest"
+    steps:
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: modVerify
+        working-directory: ./examples/datastore
+        run: go mod verify
+
+      - name: modTidy
+        working-directory: ./examples/datastore
+        run: make tools-tidy
+
+      - name: gotestsum
+        working-directory: ./examples/datastore
+        run: make test-unit
+
+      - name: Run checker
+        run: |
+          ./scripts/check_environment.sh
+
+      - name: Test Summary
+        uses: test-summary/action@4ee9ece4bca777a38f05c8fc578ac2007fe266f7
+        with:
+          paths: "**/TEST-datastore*.xml"
+        if: always()

.github/workflows/firestore-example.yml

@@ -0,0 +1,42 @@
+name: Firestore example pipeline
+
+on: [push, pull_request]
+
+jobs:
+  test-firestore:
+    strategy:
+      matrix:
+        go-version: [1.18.x, 1.x]
+    runs-on: "ubuntu-latest"
+    steps:
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: modVerify
+        working-directory: ./examples/firestore
+        run: go mod verify
+
+      - name: modTidy
+        working-directory: ./examples/firestore
+        run: make tools-tidy
+
+      - name: gotestsum
+        working-directory: ./examples/firestore
+        run: make test-unit
+
+      - name: Run checker
+        run: |
+          ./scripts/check_environment.sh
+
+      - name: Test Summary
+        uses: test-summary/action@4ee9ece4bca777a38f05c8fc578ac2007fe266f7
+        with:
+          paths: "**/TEST-firestore*.xml"
+        if: always()

.github/workflows/nginx-example.yml

@@ -0,0 +1,42 @@
+name: Nginx example pipeline
+
+on: [push, pull_request]
+
+jobs:
+  test-nginx:
+    strategy:
+      matrix:
+        go-version: [1.18.x, 1.x]
+    runs-on: "ubuntu-latest"
+    steps:
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: modVerify
+        working-directory: ./examples/nginx
+        run: go mod verify
+
+      - name: modTidy
+        working-directory: ./examples/nginx
+        run: make tools-tidy
+
+      - name: gotestsum
+        working-directory: ./examples/nginx
+        run: make test-unit
+
+      - name: Run checker
+        run: |
+          ./scripts/check_environment.sh
+
+      - name: Test Summary
+        uses: test-summary/action@4ee9ece4bca777a38f05c8fc578ac2007fe266f7
+        with:
+          paths: "**/TEST-nginx*.xml"
+        if: always()

.github/workflows/pubsub-example.yml

@@ -0,0 +1,42 @@
+name: Pubsub example pipeline
+
+on: [push, pull_request]
+
+jobs:
+  test-pubsub:
+    strategy:
+      matrix:
+        go-version: [1.18.x, 1.x]
+    runs-on: "ubuntu-latest"
+    steps:
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: modVerify
+        working-directory: ./examples/pubsub
+        run: go mod verify
+
+      - name: modTidy
+        working-directory: ./examples/pubsub
+        run: make tools-tidy
+
+      - name: gotestsum
+        working-directory: ./examples/pubsub
+        run: make test-unit
+
+      - name: Run checker
+        run: |
+          ./scripts/check_environment.sh
+
+      - name: Test Summary
+        uses: test-summary/action@4ee9ece4bca777a38f05c8fc578ac2007fe266f7
+        with:
+          paths: "**/TEST-pubsub*.xml"
+        if: always()

.github/workflows/pulsar-example.yml

@@ -0,0 +1,42 @@
+name: Pulsar example pipeline
+
+on: [push, pull_request]
+
+jobs:
+  test-pulsar:
+    strategy:
+      matrix:
+        go-version: [1.18.x, 1.x]
+    runs-on: "ubuntu-latest"
+    steps:
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: modVerify
+        working-directory: ./examples/pulsar
+        run: go mod verify
+
+      - name: modTidy
+        working-directory: ./examples/pulsar
+        run: make tools-tidy
+
+      - name: gotestsum
+        working-directory: ./examples/pulsar
+        run: make test-unit
+
+      - name: Run checker
+        run: |
+          ./scripts/check_environment.sh
+
+      - name: Test Summary
+        uses: test-summary/action@4ee9ece4bca777a38f05c8fc578ac2007fe266f7
+        with:
+          paths: "**/TEST-pulsar*.xml"
+        if: always()

.github/workflows/redis-example.yml

@@ -0,0 +1,42 @@
+name: Redis example pipeline
+
+on: [push, pull_request]
+
+jobs:
+  test-redis:
+    strategy:
+      matrix:
+        go-version: [1.18.x, 1.x]
+    runs-on: "ubuntu-latest"
+    steps:
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: modVerify
+        working-directory: ./examples/redis
+        run: go mod verify
+
+      - name: modTidy
+        working-directory: ./examples/redis
+        run: make tools-tidy
+
+      - name: gotestsum
+        working-directory: ./examples/redis
+        run: make test-unit
+
+      - name: Run checker
+        run: |
+          ./scripts/check_environment.sh
+
+      - name: Test Summary
+        uses: test-summary/action@4ee9ece4bca777a38f05c8fc578ac2007fe266f7
+        with:
+          paths: "**/TEST-redis*.xml"
+        if: always()

.github/workflows/spanner-example.yml

@@ -0,0 +1,42 @@
+name: Spanner example pipeline
+
+on: [push, pull_request]
+
+jobs:
+  test-spanner:
+    strategy:
+      matrix:
+        go-version: [1.18.x, 1.x]
+    runs-on: "ubuntu-latest"
+    steps:
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: modVerify
+        working-directory: ./examples/spanner
+        run: go mod verify
+
+      - name: modTidy
+        working-directory: ./examples/spanner
+        run: make tools-tidy
+
+      - name: gotestsum
+        working-directory: ./examples/spanner
+        run: make test-unit
+
+      - name: Run checker
+        run: |
+          ./scripts/check_environment.sh
+
+      - name: Test Summary
+        uses: test-summary/action@4ee9ece4bca777a38f05c8fc578ac2007fe266f7
+        with:
+          paths: "**/TEST-spanner*.xml"
+        if: always()