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.

Sign up for GitHub

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

Jump to bottom

Fix conflicting docs for /tekton/steps API Compatibility. #4395

Merged
merged 1 commit into from
Nov 25, 2021
Merged

Fix conflicting docs for /tekton/steps API Compatibility. #4395

merged 1 commit into from
Nov 25, 2021

Conversation

wlynch
Copy link
Member

@wlynch wlynch commented Nov 24, 2021 •
edited

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:

  • Docs included if any changes are user facing
  • Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Release notes block below has been filled in or deleted (only if no user facing changes)

Release Notes

action required: Users should not assume the directory/file structure of /tekton/steps. Use $(steps.step-<step-name>.exitCode.path) instead.

@wlynch
Fix conflicting docs for /tekton/steps API Compatibility.
b109ff2 
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.
@tekton-robot tekton-robot added release-note-action-required Denotes a PR that introduces potentially breaking changes that require user action. kind/documentation Categorizes issue or PR as related to documentation. labels Nov 24, 2021
@tekton-robot tekton-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 24, 2021
@wlynch
Copy link
Member Author

wlynch commented Nov 24, 2021

/assign @bobcatfish @pritidesai

pritidesai
pritidesai reviewed Nov 24, 2021
View reviewed changes
docs/developers/README.md
@@ -202,7 +202,6 @@ The following directories are covered by the
relied on for stability:

- `/tekton/results`
Copy link
Member

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.

pritidesai
pritidesai approved these changes Nov 24, 2021
View reviewed changes
Copy link
Member

@pritidesai pritidesai left a comment

Choose a reason for hiding this comment

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

thanks @wlynch

@tekton-robot
Copy link
Collaborator

[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 /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 Nov 24, 2021
@wlynch
Copy link
Member Author

wlynch commented Nov 24, 2021

/test pull-tekton-pipeline-alpha-integration-tests

1 similar comment
@wlynch
Copy link
Member Author

wlynch commented Nov 24, 2021

/test pull-tekton-pipeline-alpha-integration-tests

@bobcatfish
Copy link
Collaborator

Thanks for the discussion and update @pritidesai @wlynch !

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Nov 25, 2021
@tekton-robot tekton-robot merged commit df5cc01 into tektoncd:main Nov 25, 2021
@wlynch wlynch mentioned this pull request Dec 7, 2021
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pritidesai pritidesai pritidesai approved these changes

@bobcatfish bobcatfish Awaiting requested review from bobcatfish

@jerop jerop Awaiting requested review from jerop

Assignees

@pritidesai pritidesai

@bobcatfish bobcatfish

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note-action-required Denotes a PR that introduces potentially breaking changes that require user action. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@wlynch @tekton-robot @bobcatfish @pritidesai