Fail PR if it has a structural schema change in a released version #2864
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
balopat
requested review from
dgageot,
nkubala,
priyawadhwa and
tejal29
as code owners
balopat
changed the title
balopat
force-pushed
the
check_ast_change
branch
2 times, most recently
from
584a881 to
8d2736e
Compare
hack/check-schema-changes.sh checks whether the PR compared to master contains any changes in the config.go files under pkg/skaffold/schema. If yes, it checks if those changes are structural changes or not. If they are and the package is not "latest", then we'll fail the PR as we assume anything else than latest is already released and shouldn't be changed. If the change is latest and it is released, we fail the PR for the same reason. If the change is in latest and it is not released yet, it is fine to make changes.
balopat
force-pushed
the
check_ast_change
branch
from
1501dd2 to
a7a5970
Compare
tejal29
reviewed
Sep 12, 2019
balopat
force-pushed
the
check_ast_change
branch
from
b6e604b to
6a6418d
Compare
tejal29
approved these changes
Sep 13, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The most important part of #2775.
I broke it up to 2 PRs - this one is going to be the second one, should be rebased and merged AFTER the refactoring one: #2867
It checks whether the PR compared to master contains any changes in the
config.gofiles underpkg/skaffold/schema. If yes, it checks if those changes are structural changes or not. If they are and the package is not "latest", then we'll fail the PR as we assume anything else thanlatestis already released and shouldn't be changed. If the change islatestand it is released, we fail the PR for the same reason. If the change is inlatestand it is not released yet, it is fine to make changes.I decided to compare against master. This enables to override this check in case it gets in the way (some kind of historical refactoring that this check recognizes as a structural change incorrectly, or in case we do want to introduce a structural change historically) - if a maintainer has Admin rights they can merge it still.
detected structural change in released version:
Example Travis Build on this PR: https://travis-ci.com/GoogleContainerTools/skaffold/jobs/234305164
detected structural changes in unreleased
latest:Example Travis Build on this PR: https://travis-ci.com/GoogleContainerTools/skaffold/jobs/234305550
structural change in
latestthat is also released (i.e. on a PR that tries to modify config after a release):Example Travis Build on this PR (simulated by temporarily switching the released logic):
https://travis-ci.com/GoogleContainerTools/skaffold/jobs/234306518
Error handling when failed to list Github repos: