Skip to content
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.

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

Add a CI check for griffe check #270

Open
llucax opened this issue May 30, 2024 · 1 comment
Open

Add a CI check for griffe check #270

llucax opened this issue May 30, 2024 · 1 comment
Labels
part:ci Affects the GitHub workflow and other parts for running CI part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:enhancement New feature or enhancement visitble to users
Milestone

Comments

@llucax
Copy link
Contributor

llucax commented May 30, 2024

What's needed?

It would be awesome to make sure breaking changes are never introduced unintentionally.

Proposed solution

Use griffe check:

Griffe is able to compare two snapshots of a project to detect API breakages between the old and the new snapshot. By snapshot we mean a specific point in the project's history. For example, you can ask Griffe to compare your current code against a specific tag, or to compare two versions of the same Python package.

We could run this on every PR and mark the PR as failed unless the scope:breaking-change label is manually added to the PR, to make sure people reviewing the PR is aware that breaking changes were introduced.

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response

@llucax llucax added part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:enhancement New feature or enhancement visitble to users part:ci Affects the GitHub workflow and other parts for running CI labels May 30, 2024
@llucax llucax added this to the Untriaged milestone May 30, 2024
@pawamoy
Copy link

pawamoy commented May 30, 2024

Just a quick note: there are still some false-positives, like adding an item to a dictionary attribute. Working towards making this more usable, but for now I am myself not failing CI based on griffe check's result :) I mostly use it as a local warning. See our bug tracker for various improvements we track ^^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:ci Affects the GitHub workflow and other parts for running CI part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:enhancement New feature or enhancement visitble to users
Projects
None yet
Development

No branches or pull requests

2 participants