mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-06 07:50:32 +00:00
9114abe919
* Added towncrier and clone changelog from GitHub Releases page * Added record to changelog * Extended makefile * Fix typo * Changed ref in changelog * Auto-confirm towncrier question on build Co-authored-by: evgfilim1 <evgfilim1@yandex.ru>
145 lines
4.3 KiB
Makefile
145 lines
4.3 KiB
Makefile
.DEFAULT_GOAL := help
|
|
|
|
base_python := python3
|
|
py := poetry run
|
|
python := $(py) python
|
|
|
|
package_dir := aiogram
|
|
tests_dir := tests
|
|
scripts_dir := scripts
|
|
code_dir := $(package_dir) $(tests_dir) $(scripts_dir)
|
|
reports_dir := reports
|
|
|
|
redis_connection := redis://localhost:6379
|
|
|
|
.PHONY: help
|
|
help:
|
|
@echo "======================================================================================="
|
|
@echo " aiogram build tools "
|
|
@echo "======================================================================================="
|
|
@echo "Environment:"
|
|
@echo " help: Show this message"
|
|
@echo " install: Install development dependencies"
|
|
@echo " clean: Delete temporary files"
|
|
@echo ""
|
|
@echo "Code quality:"
|
|
@echo " lint: Lint code by isort, black, flake8 and mypy tools"
|
|
@echo " reformat: Reformat code by isort and black tools"
|
|
@echo ""
|
|
@echo "Tests:"
|
|
@echo " test: Run tests"
|
|
@echo " test-coverage: Run tests with HTML reporting (results + coverage)"
|
|
@echo " test-coverage-report: Open coverage report in default system web browser"
|
|
@echo ""
|
|
@echo "Documentation:"
|
|
@echo " docs: Build docs"
|
|
@echo " docs-serve: Serve docs for local development"
|
|
@echo " docs-prepare-reports: Move all HTML reports to docs dir"
|
|
@echo ""
|
|
@echo "Project"
|
|
@echo " build: Run tests build package and docs"
|
|
@echo ""
|
|
|
|
# =================================================================================================
|
|
# Environment
|
|
# =================================================================================================
|
|
|
|
.PHONY: install
|
|
install:
|
|
$(base_python) -m pip install --user -U poetry
|
|
poetry install
|
|
|
|
.PHONY: clean
|
|
clean:
|
|
rm -rf `find . -name __pycache__`
|
|
rm -f `find . -type f -name '*.py[co]' `
|
|
rm -f `find . -type f -name '*~' `
|
|
rm -f `find . -type f -name '.*~' `
|
|
rm -rf `find . -name .pytest_cache`
|
|
rm -rf *.egg-info
|
|
rm -f .coverage
|
|
rm -f report.html
|
|
rm -f .coverage.*
|
|
rm -rf {build,dist,site,.cache,.mypy_cache,reports}
|
|
|
|
# =================================================================================================
|
|
# Code quality
|
|
# =================================================================================================
|
|
|
|
.PHONY: lint
|
|
lint:
|
|
$(py) isort --check-only $(code_dir)
|
|
$(py) black --check --diff $(code_dir)
|
|
$(py) flake8 $(code_dir)
|
|
$(py) mypy $(package_dir)
|
|
|
|
.PHONY: reformat
|
|
reformat:
|
|
$(py) black $(code_dir)
|
|
$(py) isort $(code_dir)
|
|
|
|
# =================================================================================================
|
|
# Tests
|
|
# =================================================================================================
|
|
|
|
.PHONY: test
|
|
test:
|
|
$(py) pytest --cov=aiogram --cov-config .coveragerc tests/ --redis $(redis_connection)
|
|
|
|
.PHONY: test-coverage
|
|
test-coverage:
|
|
mkdir -p $(reports_dir)/tests/
|
|
$(py) pytest --cov=aiogram --cov-config .coveragerc --html=$(reports_dir)/tests/index.html tests/ --redis $(redis_connection)
|
|
|
|
.PHONY: test-coverage-report
|
|
test-coverage-report:
|
|
$(py) coverage html -d $(reports_dir)/coverage
|
|
|
|
.PHONY: test-coverage-view
|
|
test-coverage-view:
|
|
$(py) coverage html -d $(reports_dir)/coverage
|
|
python -c "import webbrowser; webbrowser.open('file://$(shell pwd)/reports/coverage/index.html')"
|
|
|
|
# =================================================================================================
|
|
# Docs
|
|
# =================================================================================================
|
|
|
|
.PHONY: docs-serve
|
|
docs-serve:
|
|
rm -rf docs/_build
|
|
$(py) sphinx-autobuild --watch aiogram/ docs/ docs/_build/
|
|
|
|
# =================================================================================================
|
|
# Project
|
|
# =================================================================================================
|
|
|
|
.PHONY: build
|
|
build: clean flake8-report mypy-report test-coverage
|
|
mkdir -p site/simple
|
|
poetry build
|
|
mv dist site/simple/aiogram
|
|
|
|
.PHONY: bump
|
|
bump:
|
|
poetry version $(args)
|
|
$(python) scripts/bump_versions.py
|
|
|
|
.PHONY: towncrier-build
|
|
towncrier-build:
|
|
towncrier build --yes
|
|
|
|
.PHONY: towncrier-draft
|
|
towncrier-draft:
|
|
towncrier build --draft
|
|
|
|
.PHONY: towncrier-draft-github
|
|
towncrier-draft-github:
|
|
mkdir -p dist
|
|
towncrier build --draft | pandoc - -o dist/release.md
|
|
|
|
.PHONY: prepare-release
|
|
prepare-release: bump towncrier-draft-github towncrier-build
|
|
|
|
.PHONY: tag-release
|
|
tag-release:
|
|
git tag v$(poetry version -s)
|