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

Feature/sg 1057 add breaking change tests #1373

Merged
merged 52 commits into from
Aug 22, 2023

Conversation

Louis-Dupont
Copy link
Contributor

@Louis-Dupont Louis-Dupont commented Aug 15, 2023

Descritption

Adding automatic test that would detect breaking change, and adding it to CI.

This PR focused on the following breaking changes:

  • Import Removal (in init.py)
  • Class Removal
  • Function Removal (includes moving from file A to B)
  • Function Parameter Removal
  • Function Required Parameter Addition

Let me know if you think another important type of breaking change is not covered and that we should add it


Breaking Change test

I created a branch to make sure the test indeed breaks the CI when a breaking change is introduced.
image
image

@Louis-Dupont Louis-Dupont marked this pull request as ready for review August 16, 2023 09:32
This was referenced Aug 16, 2023
Copy link
Collaborator

@ofrimasad ofrimasad left a comment

Choose a reason for hiding this comment

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

This looks great!!
very nice.
minor comments and questions

.circleci/config.yml Outdated Show resolved Hide resolved
@Louis-Dupont
Copy link
Contributor Author

I moved the test to a new CI "check". As you can see in the screenshot, the breaking change test is separate from the regular build3.8
image

Copy link
Collaborator

@ofrimasad ofrimasad left a comment

Choose a reason for hiding this comment

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

LGTM!
great work @Louis-Dupont

@ofrimasad ofrimasad merged commit f7d9909 into master Aug 22, 2023
7 checks passed
@ofrimasad ofrimasad deleted the feature/SG-1057-add_breaking_change_tests branch August 22, 2023 14:00
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.

None yet

2 participants