Skip to content

Commit 6fad6f1

Browse files
committed
Add make compiledeps
1 parent 1469838 commit 6fad6f1

File tree

3 files changed

+36
-4
lines changed

3 files changed

+36
-4
lines changed

Makefile

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@ help: ensurevenv
1313
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1414
@echo "---"
1515
@echo " bumpdeps to bump dependencies in requirement files."
16+
@echo " compiledeps to update requirements.txt files to adhere to dependencies"
17+
@echo " declared in requirements.in files (with minimal version changes)."
1618

17-
.PHONY: help bumpdeps ensurevenv Makefile
19+
.PHONY: help bumpdeps compiledeps ensurevenv Makefile
1820

1921
# Note to whoever sees this in future:
2022
# Using indentation before `ensurevenv` lines breaks this target
@@ -43,8 +45,17 @@ ensurevenv: ;
4345

4446
bumpdeps: ensurevenv
4547
echo.- Upgrading requirement files
46-
venv/bin/pip-compile --quiet --upgrade
47-
venv/bin/pip-compile --quiet --upgrade dev-requirements.in
48+
./venv/bin/pip-compile --quiet --upgrade
49+
./venv/bin/pip-compile --quiet --upgrade dev-requirements.in
50+
$(MAKE) aftercompiledeps
51+
52+
compiledeps: ensurevenv
53+
echo.- Compiling requirement files
54+
./venv/bin/pip-compile --quiet
55+
./venv/bin/pip-compile --quiet dev-requirements.in
56+
$(MAKE) aftercompiledeps
57+
58+
aftercompiledeps:
4859
-./venv/bin/pre-commit run mixed-line-ending --files requirements.txt dev-requirements.txt >/dev/null
4960
git diff -U1 -- ./requirements.txt ./dev-requirements.txt
5061
@echo

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ needed by this documentation.
2525

2626
To update dependencies, run `make bumpdeps`.
2727

28+
## Adding new build dependencies
29+
30+
To add new build dependencies, add them to appropriate file (`requirements.in`
31+
for docs build requirements, `dev-requirements.in` for dev requirements) and
32+
run `make compiledeps` to automatically update `requirements.txt` appropriately.
33+
2834
## License
2935

3036
See the [LICENSE file](LICENSE) for details.

make.bat

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ set SOURCEDIR=source
1414
set BUILDDIR=build
1515

1616
if "%1" == "bumpdeps" goto bumpdeps
17+
if "%1" == "compiledeps" goto compiledeps
1718
if "%1" == "" goto help
1819

1920
call :ensurevenv
@@ -45,18 +46,32 @@ call :ensurevenv
4546
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
4647
echo.---
4748
echo. bumpdeps to bump dependencies in requirement files.
49+
echo. compiledeps to update requirements.txt files to adhere to dependencies
50+
echo. declared in requirements.in files (with minimal version changes).
4851
goto end
4952

5053
:bumpdeps
5154
call :ensurevenv
5255
echo.- Upgrading requirement files
5356
venv\Scripts\pip-compile --quiet --upgrade
5457
venv\Scripts\pip-compile --quiet --upgrade dev-requirements.in
58+
call :aftercompiledeps
59+
goto end
60+
61+
:compiledeps
62+
call :ensurevenv
63+
echo.- Compiling requirement files
64+
venv\Scripts\pip-compile --quiet
65+
venv\Scripts\pip-compile --quiet dev-requirements.in
66+
call :aftercompiledeps
67+
goto end
68+
69+
:aftercompiledeps
5570
venv\Scripts\pre-commit run mixed-line-ending --files requirements.txt dev-requirements.txt >nul
5671
git diff -U1 -- requirements.txt dev-requirements.txt
5772
echo.
5873
call :ensurevenv
59-
goto end
74+
goto :eof
6075

6176
:end
6277
popd

0 commit comments

Comments
 (0)