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

[doc] fix profile activation sample #5222

Merged
merged 1 commit into from
Jan 13, 2021

Conversation

mblottiere
Copy link
Contributor

Description
This fixes a missing "-" in the profile config sample where multiple triggers are demonstrated.

User facing changes (remove if N/A)
This only impacts documentation.

@mblottiere mblottiere requested a review from a team as a code owner January 12, 2021 10:56
@google-cla google-cla bot added the cla: yes label Jan 12, 2021
@codecov
Copy link

codecov bot commented Jan 12, 2021

Codecov Report

Merging #5222 (48a4555) into master (95092ad) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #5222   +/-   ##
=======================================
  Coverage   71.84%   71.84%           
=======================================
  Files         387      387           
  Lines       13974    13974           
=======================================
  Hits        10040    10040           
  Misses       3195     3195           
  Partials      739      739           

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 95092ad...48a4555. Read the comment docs.

Copy link
Member

@briandealwis briandealwis left a comment

Choose a reason for hiding this comment

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

Thanks!

@briandealwis briandealwis merged commit d4d0c07 into GoogleContainerTools:master Jan 13, 2021
@ml-
Copy link

ml- commented Mar 18, 2021

@mblottiere Hi, please excuse the late message in this already merged PR.

Looking at the doc where this sample is included, it looks to me like it was correct before.

https://github.com/GoogleContainerTools/skaffold/blob/master/docs/content/en/docs/environment/profiles.md

In the example below:

 * `profile1` is activated if `MAGIC_VAR` is 42
 * `profile2` is activated if `MAGIC_VAR` is 1337 or we are running `skaffold dev` while kubecontext is set to `minikube`.

{{% readfile file="samples/profiles/activations.yaml" %}}

What I see here is:

if MAGIC_VAR == 1337 or (command == "dev" and kubeContext == "minikube"):
  profile2

Is this simply a misunderstanding or could you kindly point out where I made the mistake?

@mblottiere
Copy link
Contributor Author

@ml- you are completely right 😱 this PR indeed introduced a mismatch between documentation and example.
Revert PR incoming.

mblottiere added a commit to mblottiere/skaffold that referenced this pull request Mar 18, 2021
MarlonGamez pushed a commit that referenced this pull request Mar 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants