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

Document behaviour of script field when "$$" and "$(X)" are used #3939

Closed
wants to merge 1 commit into from
Closed

Document behaviour of script field when "$$" and "$(X)" are used #3939

wants to merge 1 commit into from

Conversation

ghost
Copy link

@ghost ghost commented May 11, 2021

Changes

There are some nuances and slightly confusing behaviour present in
the way our script field works. These relate to the way Kubernetes
processes the args field of containers in order to replace variable
references of form $(X).

This commit documents the way Kubernetes' variable reference code
can mangle the contents of Tekton's script blocks.

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

Release Notes

Documented some ways that script fields of Tasks can have their contents slightly mangled by Kubernetes' variable reference feature

@ghost ghost added the kind/documentation Categorizes issue or PR as related to documentation. label May 11, 2021
@tekton-robot tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label May 11, 2021
@tekton-robot tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 11, 2021
@ghost
Copy link
Author

ghost commented May 11, 2021

/hold

This shouldn't be merged until after the $$ fix reversion goes in.

@tekton-robot tekton-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 11, 2021
There are some nuances and slightly confusing behaviour present in
the way our `script` field works. These relate to the way Kubernetes
processes the `args` field of containers in order to replace variable
references of form `$(X)`.

This commit documents the way Kubernetes' variable reference code
can mangle the contents of Tekton's `script` blocks.
@ghost
Copy link
Author

ghost commented May 11, 2021

/hold cancel

#3938 has been merged.

@tekton-robot tekton-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 11, 2021
Copy link
Member

@jerop jerop left a comment

Choose a reason for hiding this comment

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

thanks @sbwsg!

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jerop

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 11, 2021
@ghost
Copy link
Author

ghost commented May 22, 2021

/hold

We won't need this if #3963 goes in instead.

@tekton-robot tekton-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 22, 2021
@ghost
Copy link
Author

ghost commented Jun 10, 2021

I'm closing this on the assumption that #3963 is probably the better way forward.

@ghost ghost closed this Jun 10, 2021
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/documentation Categorizes issue or PR as related to documentation. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants