Skip to content

Add CI check for cargo-semver-checks #15408

Open
@logan-keede

Description

@logan-keede

Is your feature request related to a problem or challenge?

DataFusion is a rapidly evolving codebase. With many minor and major changes every week, through this all we try to minimise unnecessary API changes/breaks as much as possible but every change has the possibility of causing API changes in ways we can not predict. Here is a nice article about this.

Describe the solution you'd like

cargo-semver-checks is a cargo tool made for specific purpose of automatically identifying API changes (and avoid breaking Semantic Versioning, not that relevant for us as we have pretty much only major release every month.).
Its general usage is explained in above mentioned article.
We can use this tool in a CI to check if a particular PR/merge has broken any API or not.
Note: (IMO)This CI check is not supposed to be a blocker but a way to avoid uninformed API changes.

Describe alternatives you've considered

Search for other similar tools or continue to predict API changes without any tool.

Additional context

Discussion: More thorough contribution guideline.
Article: SemVer in Rust: Tooling, Breakage, and Edge Cases

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions