Merge branch 'main' of https://github.com/testcontainers/testcontaine…

…rs-c into docker-compose

.devcontainer/Dockerfile

@@ -0,0 +1,4 @@
+FROM python:3.10.4-slim-buster
+
+RUN apt-get update
+RUN apt-get install -y libsass-dev build-essential libcairo2 git libpango-1.0-0 libpangoft2-1.0-0 pangocairo-1.0 pngquant

.devcontainer/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-2024 Kento Shimada, Oleg Nenashev, and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

.devcontainer/README.md

@@ -0,0 +1,8 @@
+# Testcontainers for C/C++. DevContainer
+
+This is an experimental Dev Container for the project site that
+does not yet include the build tools.
+
+## Included Toolchains
+
+- Python/MkDocs - for the project site and documentation development

.devcontainer/devcontainer.json

@@ -0,0 +1,30 @@
+// Credits - https://github.com/hitsumabushi845/MkDocs-with-Remote-Containers
+{
+    "name": "Material for MkDocs",
+    "dockerFile": "Dockerfile",
+    "customizations": {
+      "vscode": {
+        // Set *default* container specific settings.json values on container create.
+        "settings": {
+          "terminal.integrated.shell.linux": "/bin/bash",
+          "debug.javascript.usePreview": false
+        },
+        // Add the IDs of extensions you want installed when the container is created.
+        "extensions": [
+          "yzhang.markdown-all-in-one",
+          "redhat.vscode-yaml",
+          "shardulm94.trailing-spaces",
+          "oderwat.indent-rainbow",
+          "msjsdiag.debugger-for-chrome"
+        ],
+      },
+    },
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    "forwardPorts": [
+      8000
+    ],
+    // Use 'postCreateCommand' to run commands after the container is created.
+    "postCreateCommand": "pip3 install -r .devcontainer/requirements.txt "
+    // Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
+    //"remoteUser": "vscode"
+  }

.devcontainer/requirements.txt

@@ -0,0 +1,35 @@
+Markdown==3.5
+MarkupSafe==2.1.3
+mergedeep==1.3.4
+mkdocs==1.6.0
+mkdocstrings==0.25.1
+mkdocs-autorefs==0.5.0
+mkdocs-macros-plugin==1.0.5
+mkdocs-material==9.5.28
+mkdocs-material[imaging]==9.5.28
+mkdocs-multirepo-plugin==0.6.3
+mkdocs-redirects==1.2.1
+mkdocs-extra-sass-plugin==0.1.0
+mkdocs-render-swagger-plugin==0.1.1
+mkdocs-same-dir==0.1.3
+mkdocs-pdf==0.1.1
+mkdocs_github_changelog==0.1.0
+livereload==2.6.3
+lxml==4.9.3
+click==8.1.7
+dacite==1.8.1
+ghp-import==2.1.0
+jinja2==3.1.2
+mypy-extensions==1.0.0
+packaging==23.2
+pathspec==0.11.2
+platformdirs==3.11.0
+python-dateutil==2.8.2
+python-slugify==8.0.1
+pyyaml==6.0.1
+pyyaml-env-tag==0.1
+six==1.16.0
+text-unidecode==1.3
+typing-extensions==4.8.0
+typing-inspect==0.8.0
+watchdog==3.0.0

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @oleg-nenashev

.github/pull_request_template.md

@@ -0,0 +1,39 @@
+<!-- Type of change
+Please label this PR with one of the existing labels, depending on the scope of your change.
+-->
+
+## What does this PR do?
+
+<!-- Mandatory
+Explain here the changes you made on the PR. Please explain the WHAT: patterns used, algorithms implemented, design architecture, etc.
+-->
+
+## Why is it important?
+
+<!-- Mandatory
+Explain here the WHY, or the rationale / motivation for the changes.
+-->
+
+## Related issues
+
+<!-- Recommended
+Link related issues below. Insert the issue link or reference after the word "Closes" if merging this should automatically close it.
+
+- Closes #123
+- Relates #123
+- Requires #123
+- Supersedes #123
+-->
+-
+
+<!-- Recommended
+## How to test this PR
+
+Explain here how this PR will be tested by the reviewer: commands, dependencies, steps, etc.
+-->
+
+<!-- Optional
+## Follow-ups
+
+Add here any thought that you consider could be identified as an actionable step once this PR is merged.
+-->

.github/release-drafter.yml

@@ -0,0 +1,60 @@
+# Configuration for Release Drafter: https://github.com/toolmantim/release-drafter
+name-template: v$NEXT_PATCH_VERSION
+tag-template: v$NEXT_PATCH_VERSION
+
+# Emoji reference: https://gitmoji.carloscuesta.me/
+categories:
+  - title: 💥 Breaking changes
+    labels:
+      - breaking
+  - title: 🚀 New features and improvements
+    labels:
+      - enhancement
+  - title: 🐛 Bug fixes
+    labels:
+      - bug
+  - title: 📝 Documentation updates
+    labels:
+      - documentation
+  - title: 🌐 Localization and translation
+    labels:
+      - localization
+  - title: 🌐 Community-related changes
+    labels:
+      - community
+  - title: 👻 Maintenance
+    labels:
+      - chore
+      - maintenance
+  - title: 🚦 Tests
+    labels:
+      - test
+  - title: ✍ Other changes
+  # Default label used by Dependabot
+  - title: 📦 Dependency updates
+    labels:
+      - dependencies
+    collapse-after: 15
+exclude-labels:
+  - skip-changelog
+  - invalid
+
+template: |
+  <!-- Optional: add a release summary here -->
+  $CHANGES
+
+
+autolabeler:
+  - label: 'documentation'
+    files:
+      - '*.md'
+    branch:
+      - '/docs{0,1}\/.+/'
+  - label: 'bug'
+    branch:
+      - '/fix\/.+/'
+    title:
+      - '/fix/i'
+  - label: 'enhancement'
+    branch:
+      - '/feature\/.+/'

.github/workflows/changelog.yml

@@ -0,0 +1,24 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    permissions:
+      # Write permission is required to create a github release
+      contents: write
+      # Write permission is required for autolabeler
+      pull-requests: write
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        with:
+          name: next
+          tag: next
+          version: next
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci.yml

@@ -24,3 +24,35 @@ jobs:
           run-build: true
           run-test: true
           test-args: "--output-on-failure"
+
+  build-site:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: "true"
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2 
+        with:
+            registry: ghcr.io
+            username: ${{ github.repository_owner }}
+            password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build in the dev container image
+        uses: devcontainers/[email protected]
+        with:
+            imageName: ghcr.io/testcontainers/testcontainers-native-builder
+            cacheFrom: ghcr.io/testcontainers/testcontainers-native-builder
+            push: never
+            runCmd: |
+              mkdocs build
+            env: |
+              FULL_BUILD=true
+              GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}

.github/workflows/deploy-site.yml

@@ -0,0 +1,67 @@
+name: Deploy Site to GitHub Pages
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build-site:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: "true"
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2 
+        with:
+            registry: ghcr.io
+            username: ${{ github.repository_owner }}
+            password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build in the dev container image
+        uses: devcontainers/[email protected]
+        with:
+            imageName: ghcr.io/testcontainers/testcontainers-native-builder
+            cacheFrom: ghcr.io/testcontainers/testcontainers-native-builder
+            push: always
+            runCmd: |
+              mkdocs build
+            env: |
+              FULL_BUILD=true
+              GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
+     
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v1
+
+  deploy-site:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build-site
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -25,3 +25,7 @@ testcontainers-c/testcontainers.h
 *.dll
 *.so.0.0.1
 *.dll.0.0.1
+
+## MkDocs
+/.cache
+/_site

CMakeLists.txt

@@ -7,4 +7,6 @@ include_directories(${CMAKE_CURRENT_BINARY_DIR}/testcontainers-c)
 
 add_subdirectory(testcontainers-c)
 add_subdirectory(modules)
-add_subdirectory(demo)
+if(NOT DEFINED SKIP_DEMOS)
+    add_subdirectory(demo)
+endif()