mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2025-12-31 20:36:24 +00:00
reorg test structure to match tox and CI jobs, drop bumpversion for bump-my-version and move config to pyproject.toml, fix docs building
This commit is contained in:
pacrob
127
Makefile
127
Makefile
@ -5,6 +5,7 @@ CURRENT_SIGN_SETTING := $(shell git config commit.gpgSign)
|
||||
help:
|
||||
@echo "clean-build - remove build artifacts"
|
||||
@echo "clean-pyc - remove Python file artifacts"
|
||||
@echo "clean - run clean-build and clean-pyc"
|
||||
@echo "lint - fix linting issues with pre-commit"
|
||||
@echo "test - run tests quickly with the default Python"
|
||||
@echo "docs - generate docs and open in browser (linux-docs for version on linux)"
|
||||
@ -12,29 +13,6 @@ help:
|
||||
@echo "release - package and upload a release (does not run notes target)"
|
||||
@echo "dist - package"
|
||||
|
||||
FILES_TO_LINT = libp2p tests tests_interop examples setup.py
|
||||
PB = libp2p/crypto/pb/crypto.proto \
|
||||
libp2p/pubsub/pb/rpc.proto \
|
||||
libp2p/security/insecure/pb/plaintext.proto \
|
||||
libp2p/security/secio/pb/spipe.proto \
|
||||
libp2p/security/noise/pb/noise.proto \
|
||||
libp2p/identity/identify/pb/identify.proto
|
||||
PY = $(PB:.proto=_pb2.py)
|
||||
PYI = $(PB:.proto=_pb2.pyi)
|
||||
|
||||
# Set default to `protobufs`, otherwise `format` is called when typing only `make`
|
||||
all: protobufs
|
||||
|
||||
protobufs: $(PY)
|
||||
|
||||
%_pb2.py: %.proto
|
||||
protoc --python_out=. --mypy_out=. $<
|
||||
|
||||
clean-proto:
|
||||
rm -f $(PY) $(PYI)
|
||||
|
||||
clean: clean-build clean-pyc
|
||||
|
||||
clean-build:
|
||||
rm -fr build/
|
||||
rm -fr dist/
|
||||
@ -45,6 +23,8 @@ clean-pyc:
|
||||
find . -name '*~' -exec rm -f {} +
|
||||
find . -name '__pycache__' -exec rm -rf {} +
|
||||
|
||||
clean: clean-build clean-pyc
|
||||
|
||||
lint:
|
||||
@pre-commit run --all-files --show-diff-on-failure || ( \
|
||||
echo "\n\n\n * pre-commit should have fixed the errors above. Running again to make sure everything is good..." \
|
||||
@ -54,23 +34,29 @@ lint:
|
||||
test:
|
||||
pytest tests
|
||||
|
||||
build-docs:
|
||||
sphinx-apidoc -o docs/ . setup.py "*conftest*" "libp2p/tools/interop*"
|
||||
$(MAKE) -C docs clean
|
||||
$(MAKE) -C docs html
|
||||
$(MAKE) -C docs doctest
|
||||
# protobufs management
|
||||
|
||||
build-docs-ci:
|
||||
$(MAKE) -C docs latexpdf
|
||||
$(MAKE) -C docs epub
|
||||
PB = libp2p/crypto/pb/crypto.proto \
|
||||
libp2p/pubsub/pb/rpc.proto \
|
||||
libp2p/security/insecure/pb/plaintext.proto \
|
||||
libp2p/security/secio/pb/spipe.proto \
|
||||
libp2p/security/noise/pb/noise.proto \
|
||||
libp2p/identity/identify/pb/identify.proto
|
||||
PY = $(PB:.proto=_pb2.py)
|
||||
PYI = $(PB:.proto=_pb2.pyi)
|
||||
|
||||
validate-newsfragments:
|
||||
python ./newsfragments/validate_files.py
|
||||
towncrier build --draft --version preview
|
||||
## Set default to `protobufs`, otherwise `format` is called when typing only `make`
|
||||
all: protobufs
|
||||
|
||||
check-docs: build-docs validate-newsfragments
|
||||
protobufs: $(PY)
|
||||
|
||||
check-docs-ci: build-docs build-docs-ci validate-newsfragments
|
||||
%_pb2.py: %.proto
|
||||
protoc --python_out=. --mypy_out=. $<
|
||||
|
||||
clean-proto:
|
||||
rm -f $(PY) $(PYI)
|
||||
|
||||
# docs commands
|
||||
|
||||
docs: check-docs
|
||||
open docs/_build/html/index.html
|
||||
@ -78,19 +64,37 @@ docs: check-docs
|
||||
linux-docs: check-docs
|
||||
xdg-open docs/_build/html/index.html
|
||||
|
||||
package: clean
|
||||
python setup.py sdist bdist_wheel
|
||||
# docs helpers
|
||||
|
||||
validate-newsfragments:
|
||||
python ./newsfragments/validate_files.py
|
||||
towncrier build --draft --version preview
|
||||
|
||||
check-docs: build-docs validate-newsfragments
|
||||
|
||||
build-docs:
|
||||
sphinx-apidoc -o docs/ . setup.py "*conftest*" "libp2p/tools/interop*"
|
||||
$(MAKE) -C docs clean
|
||||
$(MAKE) -C docs html
|
||||
$(MAKE) -C docs doctest
|
||||
|
||||
# docs helpers for CI, which requires extra dependencies
|
||||
|
||||
check-docs-ci: build-docs build-docs-ci validate-newsfragments
|
||||
|
||||
build-docs-ci:
|
||||
$(MAKE) -C docs latexpdf
|
||||
$(MAKE) -C docs epub
|
||||
|
||||
# release commands
|
||||
|
||||
package-test: clean
|
||||
python -m build
|
||||
python scripts/release/test_package.py
|
||||
|
||||
notes:
|
||||
check-bump:
|
||||
ifndef bump
|
||||
$(error bump must be set, typically: major, minor, patch, or devnum)
|
||||
endif
|
||||
|
||||
notes: check-bump
|
||||
notes: check-bump validate-newsfragments
|
||||
# Let UPCOMING_VERSION be the version that is used for the current bump
|
||||
$(eval UPCOMING_VERSION=$(shell bumpversion $(bump) --dry-run --list | grep new_version= | sed 's/new_version=//g'))
|
||||
$(eval UPCOMING_VERSION=$(shell bump-my-version show --increment $(bump) new_version))
|
||||
# Now generate the release notes to have them included in the release commit
|
||||
towncrier build --yes --version $(UPCOMING_VERSION)
|
||||
# Before we bump the version, make sure that the towncrier-generated docs will build
|
||||
@ -98,20 +102,31 @@ notes: check-bump
|
||||
git commit -m "Compile release notes for v$(UPCOMING_VERSION)"
|
||||
|
||||
release: check-bump clean
|
||||
# require that upstream is configured for ethereum/py-libp2p
|
||||
@git remote -v | grep -E "upstream\tgit@github.com:ethereum/py-libp2p.git \(push\)|upstream\thttps://(www.)?github.com/ethereum/py-libp2p \(push\)"
|
||||
# verify that docs build correctly
|
||||
# verify that notes command ran correctly
|
||||
./newsfragments/validate_files.py is-empty
|
||||
make build-docs
|
||||
CURRENT_SIGN_SETTING=$(git config commit.gpgSign)
|
||||
git config commit.gpgSign true
|
||||
bumpversion $(bump)
|
||||
git push upstream && git push upstream --tags
|
||||
bump-my-version bump $(bump)
|
||||
python -m build
|
||||
twine upload dist/*
|
||||
git config commit.gpgSign "$(CURRENT_SIGN_SETTING)"
|
||||
git push upstream && git push upstream --tags
|
||||
twine upload dist/*
|
||||
|
||||
# release helpers
|
||||
|
||||
dist: clean
|
||||
python -m build
|
||||
ls -l dist
|
||||
check-bump:
|
||||
ifndef bump
|
||||
$(error bump must be one of: major, minor, patch, stage, or devnum)
|
||||
endif
|
||||
|
||||
check-git:
|
||||
# require that you be on a branch that's linked to upstream/main
|
||||
@if ! git status -s -b | head -1 | grep -q "\.\.upstream/main"; then \
|
||||
echo "Error: You must be on a branch that's linked to upstream/main"; \
|
||||
exit 1; \
|
||||
fi
|
||||
# require that upstream is configured for ethereum/py-libp2p
|
||||
@if ! git remote -v | grep "upstream[[:space:]]git@github.com:ethereum/py-libp2p.git (push)\|upstream[[:space:]]https://github.com/ethereum/py-libp2p (push)"; then \
|
||||
echo "Error: You must have a remote named 'upstream' that points to 'py-libp2p'"; \
|
||||
exit 1; \
|
||||
fi
|
||||
|
||||
Reference in New Issue
Block a user