feat: #83: updating the libodb and libodb pgsql recipes for conan

.devcontainer/devcontainer.json

@@ -8,7 +8,7 @@
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	// "forwardPorts": [],
 	// Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "conan remote add local-recipes ./deps --type=local-recipes-index", // Add a local recipes store for odb libraries
+	"postCreateCommand": "git submodule update --init && conan remote add local-recipes ./deps/conan-tourmalinecore-index --type=local-recipes-index", // Add a local recipes store for odb libraries
 	// Configure tool-specific properties.
 	// "customizations": {},
 	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.

.github/workflows/reusable-docker-build-and-push.yml

@@ -19,6 +19,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v7
+        with:
+          submodules: true
 
       # this is needed to address this issue according to the comment https://github.com/devcontainers/ci/issues/271#issuecomment-2301764487
       # otherwise our TourmalineCore org name cannot be used in docker image names, only tourmalinecore
@@ -79,6 +81,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       # this is needed to address this issue according to the comment https://github.com/devcontainers/ci/issues/271#issuecomment-2301764487
       # otherwise our TourmalineCore org name cannot be used in docker image names, only tourmalinecore

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "deps/conan-tourmalinecore-index"]
+	path = deps/conan-tourmalinecore-index
+	url = https://github.com/TourmalineCore/conan-tourmalinecore-recipes.git
+	branch = "feature/#70-preparing-prs-for-the-libodb-and-libodb-pgsql-packages-in-the-conan-center-index"

Dockerfile

@@ -24,7 +24,7 @@ RUN apt-get -y install --no-install-recommends \
 RUN pip install conan
 
 # this is necessary so that Conan can see the local dependency recipes
-RUN conan remote add local-recipes ./deps --type=local-recipes-index
+RUN conan remote add local-recipes ./deps/conan-tourmalinecore-index --type=local-recipes-index
 
 RUN conan build . --build=missing \
     --profile:all=.devcontainer/to-dos-conan-profile.conf \

README.md

@@ -22,6 +22,12 @@ For development purposes use a devcontainer named `developing`.
 
 ### Project building
 
+First, you need to update the `conan-tourmalinecore-index` submodule, which contains Conan recipes for project dependencies not included in `conan-center-index`. Without this step, the project build will fail.
+
+> If you're working inside a VSCode devcontainer, the submodules were pulled automatically; check the `deps/` directory.
+
+To do this, run the command `git submodule update --init`. After running this command, the submodules will be pulled locally based on the state of the submodule’s fixed commit. If you need to update a fixed commit in the submodule, run the command `git submodule update --init --remote`.
+
 To build this project, open the VS Code terminal (`Ctrl + Shift + ~`) and run `conan install . --build=missing`.
 After the Conan install process, open the CMake extension and click Configure. 
 <p style="text-align: center;"><img src="docs/images/cmakeConfigure.png" alt="cmakeConfigure" width="400"/></p>