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

Report CRD breaking API schema changes with a report-breaking-changes CI job #71

Merged
merged 1 commit into from
Dec 2, 2022

Conversation

ulucinar
Copy link
Collaborator

@ulucinar ulucinar commented Dec 2, 2022

Description of your changes

This PR introduces a new report-breaking-changes CI job that detects and reports breaking API changes between the two revisions of a generated managed resource definition using the crddiff tool.

Currently, we would like to detect and report breaking API changes and not prevent them. In later iterations, we would like trigger uptests on breaking changes.

I have:

  • Run make reviewable test to ensure this PR is ready for review.

How has this code been tested

Validated using a change that introduces:

  • A new CRD
  • A CRD with a non-breaking API change
  • A CRD with a breaking API change

image

If no API changes in the CRDs (breaking or non-breaking) are detected, then the reporting step is skipped:

image

Copy link
Collaborator

@turkenh turkenh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @ulucinar, looking good!
Left a couple of comments that I think unblocking.

.github/workflows/ci.yml Show resolved Hide resolved
Makefile Show resolved Hide resolved
.github/workflows/ci.yml Show resolved Hide resolved
… CI job

Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>
@ulucinar ulucinar changed the title Report CRD breaking API schema changes with a report-breaking-changes CI job [DO NOT MERGE] Report CRD breaking API schema changes with a report-breaking-changes CI job Dec 2, 2022
@ulucinar ulucinar force-pushed the integrate-crddiff branch 2 times, most recently from 28f9458 to 056602e Compare December 2, 2022 12:35
@ulucinar ulucinar changed the title [DO NOT MERGE] Report CRD breaking API schema changes with a report-breaking-changes CI job Report CRD breaking API schema changes with a report-breaking-changes CI job Dec 2, 2022
@ulucinar ulucinar merged commit 26d5517 into crossplane-contrib:main Dec 2, 2022
@ulucinar ulucinar deleted the integrate-crddiff branch December 2, 2022 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants