Skip to content

Add a CI check for griffe check #270

@llucax

Description

@llucax

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    part:ciAffects the GitHub workflow and other parts for running CIpart:toolingAffects the development tooling (CI, deployment, dependency management, etc.)type:enhancementNew feature or enhancement visitble to users

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions