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

Examples versioning #1019

Merged
merged 5 commits into from
Sep 25, 2018
Merged

Conversation

r2d4
Copy link
Contributor

@r2d4 r2d4 commented Sep 24, 2018

Fixes #367
Fixes #1003

The examples are currently integration tested, but against the code at skaffold HEAD. Configuration changes, such as v1alpha2 -> v1alpha3 will be present at HEAD, but not in the latest released version.

When users download the latest skaffold release, the examples are written for v1alpha3, but the latest release only targets v1alpha2 and below. Therefore, the examples will all fail, and users won't be able to skaffold fix, because the old version does not know about the new transformations. (skaffold fix only helps the situation of old config, new skaffold, where this is new config, old skaffold.

We would like to keep our examples integration tested, so that they don't break for users. This PR makes integration/examples the canonical example repository. All changes are synced to examples on each release.

This solves:

  • Examples are still integration tested
  • Examples are guaranteed to stay in sync with new skaffold changes
  • Examples in the examples/ directory are runnable with the latest released version of skaffold

This adds the sync to release_note.sh script, which might not be the best place for it.

@codecov-io
Copy link

codecov-io commented Sep 24, 2018

Codecov Report

Merging #1019 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1019   +/-   ##
=======================================
  Coverage   39.98%   39.98%           
=======================================
  Files          70       70           
  Lines        3079     3079           
=======================================
  Hits         1231     1231           
  Misses       1721     1721           
  Partials      127      127

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dfd7c0d...83e71c9. Read the comment docs.

Copy link
Contributor

@nkubala nkubala left a comment

Choose a reason for hiding this comment

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

one nit, otherwise LGTM

hack/release_notes/release_notes.sh Show resolved Hide resolved
@r2d4 r2d4 merged commit 59d721b into GoogleContainerTools:master Sep 25, 2018
@r2d4 r2d4 deleted the examples-versioning branch September 25, 2018 04:17
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.

Latest Binary Out Of Date Example versioning
3 participants