Skip to content

LCORE-584: add missing Makefile targets into documentation #478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 2, 2025
Merged

LCORE-584: add missing Makefile targets into documentation #478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ test-integration: ## Run integration tests tests
@echo "Reports will be written to ${ARTIFACT_DIR}"
COVERAGE_FILE="${ARTIFACT_DIR}/.coverage.integration" uv run python -m pytest tests/integration --cov=src --cov-report term-missing --cov-report "json:${ARTIFACT_DIR}/coverage_integration.json" --junit-xml="${ARTIFACT_DIR}/junit_integration.xml" --cov-fail-under=10

test-e2e: ## Run BDD tests for the service
test-e2e: ## Run end to end tests for the service
PYTHONDONTWRITEBYTECODE=1 uv run behave --tags=-skip -D dump_errors=true @tests/e2e/test_list.txt \

check-types: ## Checks type hints in sources
Expand All @@ -45,7 +45,7 @@ openapi-doc: docs/openapi.json scripts/fix_openapi_doc.py ## Generate OpenAPI do
requirements.txt: pyproject.toml pdm.lock ## Generate requirements.txt file containing hashes for all non-devel packages
pdm export --prod --format requirements --output requirements.txt --no-extras --without evaluation

doc:
doc: ## Generate documentation for developers
scripts/gen_doc.py

docs/config.puml: src/models/config.py ## Generate PlantUML class diagram for configuration
Expand All @@ -70,34 +70,34 @@ shellcheck: ## Run shellcheck
shellcheck --version
shellcheck -- */*.sh

black:
black: ## Check source code using Black code formatter
uv run black --check .

pylint:
pylint: ## Check source code using Pylint static code analyser
uv run pylint src tests

pyright:
pyright: ## Check source code using Pyright static type checker
uv run pyright src

docstyle:
docstyle: ## Check the docstring style using Docstyle checker
uv run pydocstyle -v src

ruff:
ruff: ## Check source code using Ruff linter
uv run ruff check . --per-file-ignores=tests/*:S101 --per-file-ignores=scripts/*:S101

verify: ## Run all linters
verify: ## Run all linters
$(MAKE) black
$(MAKE) pylint
$(MAKE) pyright
$(MAKE) ruff
$(MAKE) docstyle
$(MAKE) check-types

distribution-archives: ## Generate distribution archives to be uploaded into Python registry
distribution-archives: ## Generate distribution archives to be uploaded into Python registry
rm -rf dist
uv run python -m build

upload-distribution-archives: ## Upload distribution archives into Python registry
upload-distribution-archives: ## Upload distribution archives into Python registry
uv run python -m twine upload --repository ${PYTHON_REGISTRY} dist/*

help: ## Show this help screen
Expand Down
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -560,17 +560,23 @@ Available targets are:
run Run the service locally
test-unit Run the unit tests
test-integration Run integration tests tests
test-e2e Run BDD tests for the service
test-e2e Run end to end tests for the service
check-types Checks type hints in sources
security-check Check the project for security issues
format Format the code into unified format
schema Generate OpenAPI schema file
openapi-doc Generate OpenAPI documentation
requirements.txt Generate requirements.txt file containing hashes for all non-devel packages
doc Generate documentation for developers
docs/config.puml Generate PlantUML class diagram for configuration
docs/config.png Generate an image with configuration graph
docs/config.svg Generate an SVG with configuration graph
shellcheck Run shellcheck
black Check source code using Black code formatter
pylint Check source code using Pylint static code analyser
pyright Check source code using Pyright static type checker
docstyle Check the docstring style using Docstyle checker
ruff Check source code using Ruff linter
verify Run all linters
distribution-archives Generate distribution archives to be uploaded into Python registry
upload-distribution-archives Upload distribution archives into Python registry
Expand Down