build: split prod and dev lock files for pdm (#783)

serious-scaffold · Nov 13, 2024 · fea9391 · fea9391
1 parent e476dfe
commit fea9391
Show file tree

Hide file tree

Showing 18 changed files with 1,271 additions and 964 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -25,6 +25,9 @@ jobs:
           cache: true
           python-version: ${{ matrix.python-version }}
           version: 2.20.1
+          cache-dependency-path: |
+            ./pdm.dev.lock
+            ./pdm.lock
       - run: env | sort
       - run: make prerequisites
       - run: make dev

diff --git a/.github/workflows/readthedocs-preview.yml b/.github/workflows/readthedocs-preview.yml
@@ -20,6 +20,7 @@ on:
       - Makefile
       - README.md
       - docs/**
+      - pdm.dev.lock
       - pdm.lock
 permissions:
   pull-requests: write
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -23,6 +23,9 @@ jobs:
           cache: true
           python-version: '3.12'
           version: 2.20.1
+          cache-dependency-path: |
+            ./pdm.dev.lock
+            ./pdm.lock
       - run: env | sort
       - run: make dev-doc
       - run: make doc
@@ -124,6 +127,9 @@ jobs:
           cache: true
           python-version: '3.12'
           version: 2.20.1
+          cache-dependency-path: |
+            ./pdm.dev.lock
+            ./pdm.lock
       - run: env | sort
       - env:
           PDM_PUBLISH_PASSWORD: ${{ secrets.PDM_PUBLISH_PASSWORD }}

diff --git a/.gitlab/workflows/ci.yml b/.gitlab/workflows/ci.yml
@@ -9,6 +9,7 @@ ci:
       - .venv
     key:
       files:
+        - pdm.dev.lock
         - pdm.lock
       prefix: venv-${PYTHON_VERSION}
   coverage: /TOTAL.*? (100(?:\.0+)?\%\|[1-9]?\d(?:\.\d+)?\%)$/

diff --git a/.gitlab/workflows/release.yml b/.gitlab/workflows/release.yml
@@ -7,6 +7,7 @@ pages-build:
       - .venv
     key:
       files:
+        - pdm.dev.lock
         - pdm.lock
       prefix: venv-${PYTHON_VERSION}
     policy: pull
@@ -97,6 +98,15 @@ container-publish:
     PYTHON_VERSION: ${PYTHON_VERSION}
     SOURCE_DATE_EPOCH: 0
 package-publish:
+  cache:
+    paths:
+      - .venv
+    key:
+      files:
+        - pdm.dev.lock
+        - pdm.lock
+      prefix: venv-${PYTHON_VERSION}
+    policy: pull
   rules:
     - if: $CI_COMMIT_TAG =~ /^v?(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-?(a|b|rc)(0|[1-9][0-9]*)?)?$/
   script:

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -36,7 +36,17 @@ repos:
     hooks:
       - id: pdm-sync
         name: pdm-sync
-        entry: pdm sync --clean
+        entry: pdm sync
+        language: python
+        stages:
+          - post-checkout
+          - post-merge
+          - post-rewrite
+        always_run: true
+        pass_filenames: false
+      - id: pdm-dev-sync
+        name: pdm-dev-sync
+        entry: pdm sync --lockfile pdm.dev.lock
         language: python
         stages:
           - post-checkout
@@ -50,6 +60,12 @@ repos:
         language: python
         files: ^pyproject.toml$
         pass_filenames: false
+      - id: pdm-dev-lock-check
+        name: pdm-lock-check
+        entry: pdm lock --check --lockfile pdm.dev.lock
+        language: python
+        files: ^pyproject.toml$
+        pass_filenames: false
       - id: mypy
         name: mypy
         entry: pdm run python -m mypy

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -15,6 +15,7 @@ build:
           Makefile \
           README.md \
           docs/ \
+          pdm.dev.lock \
           pdm.lock;
         then
           exit 183;

diff --git a/Makefile b/Makefile
@@ -45,13 +45,13 @@ install:
 	pdm sync --prod
 
 # Install the package in editable mode with specific optional dependencies.
-dev-%:
-	pdm sync --dev --group $*
+dev-%: install
+	pdm sync --lockfile pdm.dev.lock --no-default --dev --group $*
 
 # Prepare the development environment.
 # Install the package in editable mode with all optional dependencies and pre-commit hook.
-dev:
-	pdm sync
+dev: install
+	pdm sync --lockfile pdm.dev.lock
 	if [ "$(CI)" != "true" ] && command -v pre-commit > /dev/null 2>&1; then pre-commit install; fi
 
 # Install standalone tools
@@ -157,7 +157,7 @@ template-watch:
 	watchfiles "make template-build" template includes copier.yaml
 
 template-build:
-	find . -maxdepth 1 | grep -vE '(\.|\.git|template|includes|copier\.yaml|pdm\.lock)$$' | xargs -I {} rm -r {}
+	find . -maxdepth 1 | grep -vE '(\.|\.git|template|includes|copier\.yaml|pdm\.lock|pdm\.dev\.lock)$$' | xargs -I {} rm -r {}
 	copier copy -r HEAD --data-file includes/copier-answers-sample.yml --data repo_platform=gitlab -f . .
 	rm -rf .copier-answers.yml
 	copier copy -r HEAD --data-file includes/copier-answers-sample.yml -f . .

diff --git a/pdm.dev.lock b/pdm.dev.lock
diff --git a/pdm.lock b/pdm.lock
diff --git a/template/.pre-commit-config.yaml.jinja b/template/.pre-commit-config.yaml.jinja
@@ -37,7 +37,17 @@ repos:
     hooks:
       - id: pdm-sync
         name: pdm-sync
-        entry: pdm sync --clean
+        entry: pdm sync
+        language: python
+        stages:
+          - post-checkout
+          - post-merge
+          - post-rewrite
+        always_run: true
+        pass_filenames: false
+      - id: pdm-dev-sync
+        name: pdm-dev-sync
+        entry: pdm sync --lockfile pdm.dev.lock
         language: python
         stages:
           - post-checkout
@@ -51,6 +61,12 @@ repos:
         language: python
         files: ^pyproject.toml$
         pass_filenames: false
+      - id: pdm-dev-lock-check
+        name: pdm-lock-check
+        entry: pdm lock --check --lockfile pdm.dev.lock
+        language: python
+        files: ^pyproject.toml$
+        pass_filenames: false
       - id: mypy
         name: mypy
         entry: pdm run python -m mypy

diff --git a/template/.readthedocs.yaml.jinja b/template/.readthedocs.yaml.jinja
@@ -15,6 +15,7 @@ build:
           Makefile \
           README.md \
           docs/ \
+          pdm.dev.lock \
           pdm.lock;
         then
           exit 183;

diff --git a/template/Makefile.jinja b/template/Makefile.jinja
@@ -47,13 +47,13 @@ install:
 	pdm sync --prod
 
 # Install the package in editable mode with specific optional dependencies.
-dev-%:
-	pdm sync --dev --group $*
+dev-%: install
+	pdm sync --lockfile pdm.dev.lock --no-default --dev --group $*
 
 # Prepare the development environment.
 # Install the package in editable mode with all optional dependencies and pre-commit hook.
-dev:
-	pdm sync
+dev: install
+	pdm sync --lockfile pdm.dev.lock
 	if [ "$(CI)" != "true" ] && command -v pre-commit > /dev/null 2>&1; then pre-commit install; fi
 
 # Install standalone tools
@@ -164,7 +164,7 @@ template-watch:
 	watchfiles "make template-build" template includes copier.yaml
 
 template-build:
-	find . -maxdepth 1 | grep -vE '(\.|\.git|template|includes|copier\.yaml|pdm\.lock)$$' | xargs -I {} rm -r {}
+	find . -maxdepth 1 | grep -vE '(\.|\.git|template|includes|copier\.yaml|pdm\.lock|pdm\.dev\.lock)$$' | xargs -I {} rm -r {}
 	copier copy -r HEAD --data-file includes/copier-answers-sample.yml --data repo_platform=gitlab -f . .
 	rm -rf .copier-answers.yml
 	copier copy -r HEAD --data-file includes/copier-answers-sample.yml -f . .

diff --git a/template/[% if repo_platform == 'github' %].github[% endif %]/workflows/ci.yml.jinja b/template/[% if repo_platform == 'github' %].github[% endif %]/workflows/ci.yml.jinja
@@ -26,6 +26,9 @@ jobs:
           cache: true
           python-version: {{ '${{ matrix.python-version }}' }}
           version: 2.20.1
+          cache-dependency-path: |
+            ./pdm.dev.lock
+            ./pdm.lock
       - run: env | sort
       - run: make prerequisites
       - run: make dev

diff --git a/...if repo_platform == 'github' %].github[% endif %]/workflows/readthedocs-preview.yml.jinja b/...if repo_platform == 'github' %].github[% endif %]/workflows/readthedocs-preview.yml.jinja
@@ -20,6 +20,7 @@ on:
       - Makefile
       - README.md
       - docs/**
+      - pdm.dev.lock
       - pdm.lock
 permissions:
   pull-requests: write
diff --git a/template/[% if repo_platform == 'github' %].github[% endif %]/workflows/release.yml.jinja b/template/[% if repo_platform == 'github' %].github[% endif %]/workflows/release.yml.jinja
@@ -24,6 +24,9 @@ jobs:
           cache: true
           python-version: '{{ default_py }}'
           version: 2.20.1
+          cache-dependency-path: |
+            ./pdm.dev.lock
+            ./pdm.lock
       - run: env | sort
       - run: make dev-doc
       - run: make doc
@@ -135,6 +138,9 @@ jobs:
           cache: true
           python-version: '{{ default_py }}'
           version: 2.20.1
+          cache-dependency-path: |
+            ./pdm.dev.lock
+            ./pdm.lock
       - run: env | sort
       - env:
           PDM_PUBLISH_PASSWORD: {{ '${{ secrets.PDM_PUBLISH_PASSWORD }}' }}

diff --git a/...ab' or repo_platform == 'gitlab-self-managed' %].gitlab[% endif %]/workflows/ci.yml.jinja b/...ab' or repo_platform == 'gitlab-self-managed' %].gitlab[% endif %]/workflows/ci.yml.jinja
@@ -10,6 +10,7 @@ ci:
       - .venv
     key:
       files:
+        - pdm.dev.lock
         - pdm.lock
       prefix: venv-${PYTHON_VERSION}
   coverage: /TOTAL.*? (100(?:\.0+)?\%\|[1-9]?\d(?:\.\d+)?\%)$/

diff --git a/...r repo_platform == 'gitlab-self-managed' %].gitlab[% endif %]/workflows/release.yml.jinja b/...r repo_platform == 'gitlab-self-managed' %].gitlab[% endif %]/workflows/release.yml.jinja
@@ -8,6 +8,7 @@ pages-build:
       - .venv
     key:
       files:
+        - pdm.dev.lock
         - pdm.lock
       prefix: venv-${PYTHON_VERSION}
     policy: pull
@@ -108,6 +109,15 @@ container-publish:
     PYTHON_VERSION: ${PYTHON_VERSION}
     SOURCE_DATE_EPOCH: 0
 package-publish:
+  cache:
+    paths:
+      - .venv
+    key:
+      files:
+        - pdm.dev.lock
+        - pdm.lock
+      prefix: venv-${PYTHON_VERSION}
+    policy: pull
   rules:
     - if: $CI_COMMIT_TAG =~ /^v?(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-?(a|b|rc)(0|[1-9][0-9]*)?)?$/
   script: