From b96de6552f6cd5ab1f29e557b472ef6a9c1fda88 Mon Sep 17 00:00:00 2001 From: Collin Dutter Date: Fri, 20 Dec 2024 13:55:08 -0800 Subject: [PATCH] Add griffe to check for breaking changes --- Makefile | 4 ++++ poetry.lock | 16 ++++++++++------ pyproject.toml | 1 + 3 files changed, 15 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index 577dd53cf..58b5c0edf 100644 --- a/Makefile +++ b/Makefile @@ -93,6 +93,10 @@ check/types: .PHONY: check/spell check/spell: @poetry run typos + +.PHONY: check/breaking +check/breaking: ## Check for breaking changes. + @poetry run griffe check griptape --against main .PHONY: docs docs: ## Build documentation. diff --git a/poetry.lock b/poetry.lock index c7bb9f799..4351b8679 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1950,18 +1950,22 @@ test = ["objgraph", "psutil"] [[package]] name = "griffe" -version = "1.5.1" +version = "1.5.2.dev18+g596cf6d" description = "Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API." optional = false python-versions = ">=3.9" -files = [ - {file = "griffe-1.5.1-py3-none-any.whl", hash = "sha256:ad6a7980f8c424c9102160aafa3bcdf799df0e75f7829d75af9ee5aef656f860"}, - {file = "griffe-1.5.1.tar.gz", hash = "sha256:72964f93e08c553257706d6cd2c42d1c172213feb48b2be386f243380b405d4b"}, -] +files = [] +develop = false [package.dependencies] colorama = ">=0.4" +[package.source] +type = "git" +url = "https://github.com/mkdocstrings/griffe.git" +reference = "main" +resolved_reference = "596cf6d2f329929abfc6f8fa21a18bbc522c27ef" + [[package]] name = "grpcio" version = "1.68.1" @@ -7231,4 +7235,4 @@ loaders-sql = ["sqlalchemy"] [metadata] lock-version = "2.0" python-versions = "^3.9" -content-hash = "64d0644016a067063e7d24b95ac74340773f6bb31e006945c233d1993fe266d7" +content-hash = "e6fbf505c47fd2ac1e16c9365a93d38eb1c4f2bf1bc2eee8187cd76e36ffede7" diff --git a/pyproject.toml b/pyproject.toml index 3ee29d06c..1ddfe62f8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -229,6 +229,7 @@ mdformat-gfm = "^0.4.1" mdformat-frontmatter = "^2.0.8" mdformat-footnote = "^0.1.1" mdformat-admon = "^2.0.6" +griffe = { git="https://github.com/mkdocstrings/griffe.git", branch="main" } [tool.poetry.group.docs]