Skip to content

Commit 08c8aca

Browse files
committed
feat(install): use uv
1 parent 993ac23 commit 08c8aca

File tree

6 files changed

+31
-28
lines changed

6 files changed

+31
-28
lines changed

.github/workflows/tests.yml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ on:
99
branches:
1010
- master
1111
- production
12-
schedule:
13-
# * is a special character in YAML so you have to quote this string
14-
- cron: "0 3 * * 6"
1512
workflow_dispatch:
1613
inputs:
1714
reason:
@@ -32,13 +29,14 @@ jobs:
3229
with:
3330
python-version: 3.12
3431

35-
- name: Install dependencies
36-
run: |
37-
pip install -r requirements.txt
38-
pip freeze
32+
- name: Install uv
33+
uses: astral-sh/setup-uv@v6
34+
35+
- name: Install the project
36+
run: uv sync
3937

4038
- name: Build
41-
run: mkdocs build --clean --strict -v
39+
run: uv run mkdocs build --clean --strict -v
4240

4341
- name: Check links
4442
uses: untitaker/hyperlink@0.1.44

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
*DS_Store
22
site/*
33
.cache
4+
uv.lock

.gitlab-ci.yml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
variables:
2-
MKDOCS_VERSION: '1.6.1'
3-
MATERIAL_VERSION: '9.6.14'
4-
51
include:
6-
- project: 'authoring/documentation/mkdocs-ci'
7-
file: 'mkdocs-gitlab-pages.gitlab-ci.yml'
2+
- project: "authoring/documentation/mkdocs-ci"
3+
file: "mkdocs-gitlab-pages.gitlab-ci.yml"
4+
5+
validation:
6+
script:
7+
- apt update && apt install -y git
8+
- pip install --no-cache-dir uv
9+
- uv sync
10+
- mkdocs build -d public

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ This is the source of InvenioRDM user documentation web site. You can view the d
66

77
## Running
88

9+
Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then run:
10+
911
```console
10-
$ mkvirtualenv docs-invenio-rdm
11-
$ pip install -r requirements.txt
12-
$ mkdocs serve
12+
$ uv sync
13+
$ uv run mkdocs serve
1314
$ firefox http://127.0.0.1:8000
1415
```

pyproject.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[project]
2+
name = "docs-invenio-rdm"
3+
version = "0.1.0"
4+
description = "InvenioRDM docs"
5+
readme = "README.md"
6+
requires-python = ">=3.12"
7+
dependencies = [
8+
"mkdocs>=1.6.1",
9+
"mkdocs-glightbox>=0.5.2",
10+
"mkdocs-material>=9.6.22",
11+
]

requirements.txt

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)