-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Fix conflicting docs for /tekton/steps API Compatibility. #4395
Conversation
Previously the developer docs listed that /tekton/steps was in scope for the API compatibility policy, where-as the [user docs](https://github.com/tektoncd/pipeline/blob/aceb5880f009884be14f9a7409f428cc84157a75/docs/tasks.md#reserved-directories) did not say it was in scope. After discussion in [PR tektoncd#4352](tektoncd#4352 (comment)), we have come to agreement that this is **not** in scope. While this change in itself is not a breaking change, this opens the door for breaking changes (such as tektoncd#4352). Our stance is that users should use the [`$(steps.step-<step-name>.exitCode.path)` syntax](https://github.com/tektoncd/pipeline/blob/aceb5880f009884be14f9a7409f428cc84157a75/docs/tasks.md#accessing-steps-exitcode-in-subsequent-steps) to avoid breaking changes.
/assign @bobcatfish @pritidesai |
@@ -202,7 +202,6 @@ The following directories are covered by the | |||
relied on for stability: | |||
|
|||
- `/tekton/results` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My belief is none of the internal paths are stable and should avoid consuming them. But results
has been around since past many releases and might have been integrated by many consumers already.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks @wlynch
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: pritidesai 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 |
/test pull-tekton-pipeline-alpha-integration-tests |
1 similar comment
/test pull-tekton-pipeline-alpha-integration-tests |
Thanks for the discussion and update @pritidesai @wlynch ! /lgtm |
Changes
Previously the developer docs listed that /tekton/steps was in scope for
the API compatibility policy, where-as the user
docs
did not say it was in scope.
After discussion in
PR #4352,
we have come to agreement that this is not in scope.
While this change in itself is not a breaking change, this opens the
door for breaking changes (such as #4352). Our stance is that users
should use the
$(steps.step-<step-name>.exitCode.path)
syntax instead to ensure compatibility.
/kind documentation
Submitter Checklist
As the author of this PR, please check off the items in this checklist:
functionality, content, code)
Release Notes