Skip to content

Commit b1d09a9

Browse files
committed
Pin python libraries (#21).
Use pinned `requirements.txt` and an additional `constraints.txt` file to ensure pip constructs a viable build environment. The upstream version (see [1]) partially depends on the distribution repositories for versioning via packages like `python3-doc8` but I went though and pinned everything in the `pip` files instead to create a single source of truth independent of system packages. Based on [1] by @clalancette upstream in `ros2/ros2_documentation` [1] ros2/ros2_documentation@e43347d
1 parent dd8cff4 commit b1d09a9

File tree

4 files changed

+45
-12
lines changed

4 files changed

+45
-12
lines changed

.github/workflows/spaceros.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020

2121
- name: Install dependencies with pip
2222
run: |
23-
pip install --no-warn-script-location --user --upgrade -r requirements.txt
23+
pip install --no-warn-script-location --user -r requirements.txt -c constraints.txt
2424
2525
- name: Build
2626
run: make html
@@ -44,7 +44,7 @@ jobs:
4444

4545
- name: Install dependencies with pip
4646
run: |
47-
pip install --no-warn-script-location --user --upgrade -r requirements.txt
47+
pip install --no-warn-script-location --user -r requirements.txt -c constraints.txt
4848
4949
- name: Build
5050
run: make multiversion

constraints.txt

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Jinja2==3.0.3
2+
MarkupSafe==2.0.1
3+
Pygments==2.11.2
4+
alabaster==0.7.12
5+
babel==2.8.0
6+
certifi==2020.6.20
7+
chardet==4.0.0
8+
imagesize==1.3.0
9+
importlib-metadata==4.6.4
10+
more-itertools==8.10.0
11+
packaging==21.3
12+
pbr==5.8.0
13+
pip==22.0.2
14+
pyparsing==2.4.7
15+
pytz==2022.1
16+
requests==2.25.1
17+
restructuredtext-lint==1.3.2
18+
roman==3.3
19+
setuptools==59.6.0
20+
six==1.16.0
21+
snowballstemmer==2.2.0
22+
doc8==0.8.1
23+
docutils==0.16.0
24+
Sphinx==4.3.2
25+
sphinx-copybutton==0.4.0
26+
sphinx-multiversion==0.2.4
27+
sphinx-rtd-theme==1.0.0
28+
sphinx-sitemap==2.3.0
29+
sphinx-tabs==3.2.0
30+
stevedore==3.5.0
31+
urllib3==1.26.5
32+
wheel==0.37.1
33+
zipp==1.0.0

docker/image/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ WORKDIR /tmp/doc_repository
2525

2626
USER $user
2727

28-
CMD pip3 install --no-warn-script-location --user --upgrade -r requirements.txt && make multiversion
28+
CMD pip3 install --no-warn-script-location --user -r requirements.txt -c constraints.txt && make multiversion

requirements.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
doc8
2-
docutils==0.16
3-
pip
4-
sphinx
5-
sphinx-copybutton
6-
sphinx-multiversion
7-
sphinx-rtd-theme
8-
sphinx-sitemap
9-
sphinx-tabs
1+
doc8==0.8.1
2+
docutils==0.16.0
3+
pip==22.0.2
4+
sphinx==4.3.2
5+
sphinx-copybutton==0.4.0
6+
sphinx-multiversion==0.2.4
7+
sphinx-rtd-theme==1.0.0
8+
sphinx-sitemap==2.3.0
9+
sphinx-tabs==3.2.0

0 commit comments

Comments
 (0)