Merge pull request #2179 from gitpython-developers/subtree-merge-deps

Merge gitdb and smmap into the GitPython repository

Author: Byron

.github/dependabot.yml

@@ -6,11 +6,6 @@ updates:
   schedule:
     interval: weekly
 
-- package-ecosystem: gitsubmodule
-  directory: "/"
-  schedule:
-    interval: weekly
-
 - package-ecosystem: pre-commit
   directory: "/"
   schedule:

.github/workflows/alpine-test.yml

@@ -63,17 +63,13 @@ jobs:
     - name: Install project and test dependencies
       run: |
         . .venv/bin/activate
-        pip install '.[test]'
+        pip install ./smmap ./gitdb '.[test]'
 
     - name: Show POSIX file ownership
       run: |
         ls -ld -- \
           "$(pwd)" \
           "$(pwd)/.git" \
-          "$(pwd)/git/ext/gitdb" \
-          "$(pwd)/git/ext/gitdb/.git" \
-          "$(pwd)/git/ext/gitdb/gitdb/ext/smmap" \
-          "$(pwd)/git/ext/gitdb/gitdb/ext/smmap/.git" \
           "${HOME:?HOME is not set}/.gitconfig" \
           2>&1 || true
 

.github/workflows/codeql.yml

@@ -62,6 +62,10 @@ jobs:
       with:
         languages: ${{ matrix.language }}
         build-mode: ${{ matrix.build-mode }}
+        config: |
+          paths-ignore:
+            - gitdb/gitdb/test/**
+            - smmap/smmap/test/**
         # If you wish to specify custom queries, you can do so here or in a config file.
         # By default, queries listed here will override any specified in a config file.
         # Prefix the list here with "+" to use these queries and those in the config file.

.github/workflows/cygwin-test.yml

@@ -57,8 +57,6 @@ jobs:
       run: |
         git config --global --add safe.directory "$(pwd)"
         git config --global --add safe.directory "$(pwd)/.git"
-        git config --global --add safe.directory "$(pwd)/git/ext/gitdb"
-        git config --global --add safe.directory "$(pwd)/git/ext/gitdb/gitdb/ext/smmap"
         git config --global core.autocrlf false
 
     - name: Prepare this repo for tests
@@ -84,7 +82,7 @@ jobs:
 
     - name: Install project and test dependencies
       run: |
-        pip install '.[test]'
+        pip install ./smmap ./gitdb '.[test]'
 
     - name: Show POSIX file ownership
       # Cygwin's `ls -ld` reports the NTFS Owner SID via Cygwin's SID-to-uid
@@ -96,12 +94,6 @@ jobs:
         ls -ld -- \
           "$(pwd)" \
           "$(pwd)/.git" \
-          "$(pwd)/git/ext/gitdb" \
-          "$(pwd)/git/ext/gitdb/.git" \
-          "$(pwd)/.git/modules/gitdb" \
-          "$(pwd)/git/ext/gitdb/gitdb/ext/smmap" \
-          "$(pwd)/git/ext/gitdb/gitdb/ext/smmap/.git" \
-          "$(pwd)/.git/modules/gitdb/modules/smmap" \
           "${HOME:?HOME is not set}/.gitconfig" \
           2>&1 || true
 
@@ -114,12 +106,6 @@ jobs:
         $paths = @(
           "$pwd",
           "$pwd\.git",
-          "$pwd\git\ext\gitdb",
-          "$pwd\git\ext\gitdb\.git",
-          "$pwd\.git\modules\gitdb",
-          "$pwd\git\ext\gitdb\gitdb\ext\smmap",
-          "$pwd\git\ext\gitdb\gitdb\ext\smmap\.git",
-          "$pwd\.git\modules\gitdb\modules\smmap",
           "$env:USERPROFILE\.gitconfig"
         )
         foreach ($p in $paths) {

.github/workflows/dependencies.yml

@@ -0,0 +1,42 @@
+name: Dependency packages
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ${{ matrix.python-version == '3.7' && 'ubuntu-22.04' || 'ubuntu-latest' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        project: [smmap, gitdb]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.13t"]
+
+    steps:
+    - uses: actions/checkout@v7
+      with:
+        fetch-depth: 0
+    - uses: actions/setup-python@v7
+      with:
+        python-version: ${{ matrix.python-version }}
+        allow-prereleases: true
+    - name: Install test dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install pytest flake8 ./smmap
+        if test "${{ matrix.project }}" = gitdb; then python -m pip install ./gitdb; fi
+    - name: Lint
+      run: flake8 "${{ matrix.project }}/${{ matrix.project }}" --count --select=E9,F63,F7,F82 --show-source --statistics
+    - name: Test
+      run: |
+        if test "${{ matrix.project }}" = gitdb; then
+          GITDB_TEST_GIT_REPO_BASE="$(git rev-parse --git-common-dir)" pytest -o addopts= -v gitdb/gitdb/test
+        else
+          pytest -o addopts= -v smmap/smmap/test
+        fi

.github/workflows/pythonpackage.yml

@@ -95,7 +95,7 @@ jobs:
 
     - name: Install project and test dependencies
       run: |
-        pip install '.[test]'
+        pip install ./smmap ./gitdb '.[test]'
 
     - name: Show POSIX file ownership
       # Linux and macOS only. On Windows, Git Bash's `ls -ld` reports a
@@ -107,10 +107,6 @@ jobs:
         ls -ld -- \
           "$(pwd)" \
           "$(pwd)/.git" \
-          "$(pwd)/git/ext/gitdb" \
-          "$(pwd)/git/ext/gitdb/.git" \
-          "$(pwd)/git/ext/gitdb/gitdb/ext/smmap" \
-          "$(pwd)/git/ext/gitdb/gitdb/ext/smmap/.git" \
           "${HOME:?HOME is not set}/.gitconfig" \
           2>&1 || true
 
@@ -124,10 +120,6 @@ jobs:
         $paths = @(
           "$pwd",
           "$pwd\.git",
-          "$pwd\git\ext\gitdb",
-          "$pwd\git\ext\gitdb\.git",
-          "$pwd\git\ext\gitdb\gitdb\ext\smmap",
-          "$pwd\git\ext\gitdb\gitdb\ext\smmap\.git",
           "$env:USERPROFILE\.gitconfig"
         )
         foreach ($p in $paths) {

.gitmodules

@@ -1,3 +1,5 @@
+exclude: ^(?:gitdb|smmap)/
+
 repos:
 - repo: https://github.com/codespell-project/codespell
   rev: v2.4.2

.pre-commit-config.yaml

@@ -101,15 +101,13 @@ In the less common case that you do not want to install test dependencies, `pip
 
 #### With editable *dependencies* (not preferred, and rarely needed)
 
-In rare cases, you may want to work on GitPython and one or both of its [gitdb](https://github.com/gitpython-developers/gitdb) and [smmap](https://github.com/gitpython-developers/smmap) dependencies at the same time, with changes in your local working copy of gitdb or smmap immediately reflected in the behavior of your local working copy of GitPython. This can be done by making editable installations of those dependencies in the same virtual environment where you install GitPython.
-
-If you want to do that *and* you want the versions in GitPython's git submodules to be used, then pass `-e git/ext/gitdb` and/or `-e git/ext/gitdb/gitdb/ext/smmap` to `pip install`. This can be done in any order, and in separate `pip install` commands or the same one, so long as `-e` appears before *each* path. For example, you can install GitPython, gitdb, and smmap editably in the currently active virtual environment this way:
+GitPython, [gitdb](gitdb), and [smmap](smmap) live in this repository as independently packaged projects. To work on all three at once, install each one editably in the same virtual environment:
 
 ```sh
-pip install -e ".[test]" -e git/ext/gitdb -e git/ext/gitdb/gitdb/ext/smmap
+pip install -e smmap -e gitdb -e ".[test]"
 ```
 
-The submodules must have been cloned for that to work, but that will already be the case if you have run `./init-tests-after-clone.sh`. You can use `pip list` to check which packages are installed editably and which are installed normally.
+You can use `pip list` to check which packages are installed editably and which are installed normally.
 
 To reiterate, this approach should only rarely be used. For most development it is preferable to allow the gitdb and smmap dependencices to be retrieved automatically from PyPI in their latest stable packaged versions.
 

README.md

@@ -97,11 +97,6 @@ and cloned using::
 
 	$ git clone https://github.com/gitpython-developers/GitPython git-python
 
-Initialize all submodules to obtain the required dependencies with::
-
-    $ cd git-python
-    $ git submodule update --init --recursive
-
 Finally verify the installation by running unit tests::
 
     $ python -m unittest