Skip to content

Commit a0f9173

Browse files
authored
ci(docs): Fix installation of optional dependencies (#328)
* Change the installation step to include the full group in documentation building job of tests.yml and in build-deploy-docs.yml * Change the suggested installation of CONTRIBUTING.md to include the full group
1 parent 24e9438 commit a0f9173

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

.github/workflows/build-deploy-docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ jobs:
2222
with:
2323
python-version: '3.13'
2424

25-
- name: Install dependencies (default & doc)
26-
run: pdm install --group doc --frozen-lockfile
25+
- name: Install dependencies (default with full options & doc)
26+
run: pdm install --group full --group doc --frozen-lockfile
2727

2828
- name: Determine deployment folder
2929
id: deploy_folder

.github/workflows/tests.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
uses: pdm-project/setup-pdm@v4
2222
with:
2323
python-version: ${{ matrix.python-version }}
24-
- name: Install default and test dependencies
24+
- name: Install default (with full options) and test dependencies
2525
run: pdm install --group full --group test --frozen-lockfile
2626
- name: Run unit and doc tests with coverage report
2727
run: pdm run pytest tests/unit tests/doc --cov=src --cov-report=xml
@@ -42,8 +42,8 @@ jobs:
4242
with:
4343
python-version: '3.13'
4444

45-
- name: Install dependencies (default & doc)
46-
run: pdm install --group doc --frozen-lockfile
45+
- name: Install dependencies (default with full options & doc)
46+
run: pdm install --group full --group doc --frozen-lockfile
4747

4848
- name: Build Documentation
4949
working-directory: docs

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ with maintainers before implementing major changes.
1717
```bash
1818
pdm venv create 3.13.1 # Requires Python 3.13.1 to be installed
1919
pdm use -i .venv/bin/python
20-
pdm install --frozen-lockfile
20+
pdm install --group full --frozen-lockfile
2121
pdm run pre-commit install
2222
```
2323

0 commit comments

Comments
 (0)