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

Remove documentation advocating for test builders #3182

Merged
merged 1 commit into from Sep 9, 2020
Merged

Remove documentation advocating for test builders #3182

merged 1 commit into from Sep 9, 2020

Conversation

imjasonh
Copy link
Member

@imjasonh imjasonh commented Sep 9, 2020 •
edited

Instead, recommend that users not use them, and link to the bug with more information/discussion.

Also mark packages as Deprecated in godoc comments, which some IDEs propagate and show as warnings to users.

#3178

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • [n] Includes tests (if functionality changed/added)
  • [y] Includes docs (if user facing)
  • [y] Commit messages follow commit message best practices
  • [y] Release notes block has been filled in or deleted (only if no user facing changes)

See the contribution guide for more details.

Double check this list of stuff that's easy to miss:

Reviewer Notes

If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.

Release Notes

NONE

/assign @pritidesai
/kind documentation

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Sep 9, 2020
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 9, 2020
@pritidesai
Copy link
Member

Thanks @imjasonh this is great, should we also include recommendation on what to use? may be an example so that its easier for folks to understand why deprecating and what is an alternative ...

@chmouel
Copy link
Member

chmouel commented Sep 9, 2020

cc @piyush-garg

vdemeester
vdemeester reviewed Sep 9, 2020
View reviewed changes
Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

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

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 9, 2020
@tekton-robot tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Sep 9, 2020
@imjasonh
Copy link
Member Author

imjasonh commented Sep 9, 2020

Thanks @imjasonh this is great, should we also include recommendation on what to use? may be an example so that its easier for folks to understand why deprecating and what is an alternative ...

Done. I also just removed internal/builder/v1*/README.md since they were all just copies of each other.

@imjasonh
Remove documentation advocating for test builders
336a4b8 
Instead, recommend that users not use them, and link to the bug with
more information/discussion.

Also mark packages as Deprecated in godoc comments, which some IDEs
propagate and show as warnings to users.
@imjasonh
Copy link
Member Author

imjasonh commented Sep 9, 2020

/test pull-tekton-pipeline-integration-tests

@vdemeester
Copy link
Member

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 9, 2020
@dlorenc
Copy link
Contributor

dlorenc commented Sep 9, 2020

/approve

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 9, 2020
@imjasonh
Copy link
Member Author

imjasonh commented Sep 9, 2020 •
edited

/test pull-tekton-pipeline-integration-tests

pritidesai
pritidesai approved these changes Sep 9, 2020
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.

this is a great start, thanks @imjasonh

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dlorenc, 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 merged commit 8c302b7 into tektoncd:master Sep 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vdemeester vdemeester vdemeester left review comments

@pritidesai pritidesai pritidesai approved these changes

@bobcatfish bobcatfish Awaiting requested review from bobcatfish

Assignees

@vdemeester vdemeester

@pritidesai pritidesai

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-none Denotes a PR that doesnt merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@imjasonh @pritidesai @chmouel @vdemeester @dlorenc @tekton-robot