Don't checkout submodules by default

This makes sure that cargo does not clone and checkout all the
submodules if pointing to this repository as a git dependency.

To checkout the submodules `git submodule update --checkout` can be
used.

Author: sdroege

.github/workflows/CI.yml

@@ -139,10 +139,12 @@ jobs:
       - uses: actions/checkout@v2
         with:
           submodules: recursive
+          set-safe-directory: true
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: stable
           override: true
+      - run: git submodule update --checkout
       - run: python3 generator.py
       - run: git diff --exit-code

.github/workflows/docs.yml

@@ -10,7 +10,7 @@ name: docs
 
 jobs:
   docs:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     name: build
     container:
       image: ghcr.io/gtk-rs/gtk3-rs/gtk3:latest
@@ -23,14 +23,14 @@ jobs:
       - uses: actions/checkout@v2
         with:
           submodules: recursive
+          set-safe-directory: true
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: nightly
           override: true
           components: rustfmt
-      - working-directory: gir
-        run: cargo build --release
+      - run: git submodule update --checkout
       - run: cargo install rustdoc-stripper
       - run: python3 ./generator.py --embed-docs --yes ./
       - run: git clone https://gitlab.gnome.org/World/Rust/gir-rustdoc/ # checkout action doesn't support random urls

.gitmodules

@@ -1,6 +1,8 @@
 [submodule "gir"]
 	path = gir
 	url = https://github.com/gtk-rs/gir
+	update = none
 [submodule "gir-files"]
 	path = gir-files
 	url = https://github.com/gtk-rs/gir-files
+	update = none

README.md

@@ -41,6 +41,12 @@ file as follows:
 $ python3 generator.py
 ```
 
+If you didn't do so yet, please check out all the submodules before via
+
+```bash
+$ git submodule update --checkout
+```
+
 ## Development
 
 This repository is mostly split into two branches: `master` and `crate`.