Skip to content

Commit

Permalink
Fix conflicting docs for /tekton/steps API Compatibility.
Browse files Browse the repository at this point in the history
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 #4352](#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 #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.
  • Loading branch information
wlynch authored and tekton-robot committed Nov 25, 2021
1 parent aceb588 commit df5cc01
Showing 1 changed file with 0 additions and 1 deletion.
1 change: 0 additions & 1 deletion docs/developers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,6 @@ The following directories are covered by the
relied on for stability:

- `/tekton/results`
- `/tekton/steps`

All other files/directories are internal implementation details of Tekton -
**users should not rely on specific paths or behaviors as it may change in the
Expand Down

0 comments on commit df5cc01

Please sign in to comment.