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

Rename --async to --no-wait and deprecate it #639

Merged
merged 2 commits into from
Feb 8, 2020
Merged

Rename --async to --no-wait and deprecate it #639

merged 2 commits into from
Feb 8, 2020

Conversation

dsimansk
Copy link
Contributor

@dsimansk dsimansk commented Feb 6, 2020

Fixes #438

Proposed Changes

  • Add --no-wait flag with same behaviour as --async
  • Mark --async as deprecated in documentation and display warning message when used

Example of deprecation warning:

➜  client git:(issue-438) kn service create svc-test --image gcr.io/knative-samples/helloworld-go --async  

DEPRECATED WARNING: flag --async is going to be removed in future release, please use --no-wait instead.

Service 'svc-test' created in namespace 'default'.
➜  client git:(issue-438) kn service update svc-test --image gcr.io/knative-samples/helloworld-go --async

DEPRECATED WARNING: flag --async is going to be removed in future release, please use --no-wait instead.

Service 'svc-test' updated in namespace 'default'.
➜  client git:(issue-438) kn service update svc-test --image gcr.io/knative-samples/helloworld-go --no-wait
Service 'svc-test' updated in namespace 'default'.

@googlebot googlebot added the cla: yes Indicates the PR's author has signed the CLA. label Feb 6, 2020
knative-prow-robot
knative-prow-robot reviewed Feb 6, 2020
View reviewed changes
Copy link
Contributor

@knative-prow-robot knative-prow-robot left a comment

Choose a reason for hiding this comment

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

@dsimansk: 0 warnings.

In response to this:

Fixes #438

Proposed Changes

  • Add --no-wait flag with same behaviour as --async
  • Mark --async as deprecated in documentation and display warning message when used

Example of deprecation warning:

➜  client git:(issue-438) kn service create svc-test --image gcr.io/knative-samples/helloworld-go --async  

DEPRECATED WARNING: flag --async is going to be removed in future release, please use --no-wait instead.

Service 'svc-test' created in namespace 'default'.
➜  client git:(issue-438) kn service update svc-test --image gcr.io/knative-samples/helloworld-go --async

DEPRECATED WARNING: flag --async is going to be removed in future release, please use --no-wait instead.

Service 'svc-test' updated in namespace 'default'.
➜  client git:(issue-438) kn service update svc-test --image gcr.io/knative-samples/helloworld-go --no-wait
Service 'svc-test' updated in namespace 'default'.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@knative-prow-robot knative-prow-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 6, 2020
@dsimansk
Copy link
Contributor Author

dsimansk commented Feb 6, 2020

/assign @rhuss

maximilien
maximilien approved these changes Feb 6, 2020
View reviewed changes
Copy link
Contributor

@maximilien maximilien left a comment

Choose a reason for hiding this comment

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

Wonder if we should have a time limit on DEPRECATED flags and commands? Perhaps mentioning in the docs that commands/flags marked as DEPRECATED will be removed in future after n number of releases? I'd vote for n == 2. Thoughts?

cc @rhuss @navidshaikh @sixolet

@knative-prow-robot knative-prow-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 6, 2020
@knative-metrics-robot
Copy link

The following is the coverage report on the affected files.
Say /test pull-knative-client-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/kn/commands/service/create.go 79.1% 76.7% -2.4
pkg/kn/commands/service/update.go 78.0% 77.0% -0.9

@rhuss
Copy link
Contributor

rhuss commented Feb 7, 2020

Wonder if we should have a time limit on DEPRECATED flags and commands? Perhaps mentioning in the docs that commands/flags marked as DEPRECATED will be removed in future after n number of releases? I'd vote for n == 2. Thoughts?

Yes, I think we definitely should establish a rule. For API versioning we have Knative Release Principles and there is a rule to support n ... n-3 (so that in this case, we would remove the option in kn 0.16.0).

On the other hand, there is also the table about deprecation, which states which feature can be removed after which time, based on the maturity level.

So if we would say kn itself is "alpha", then we could remove immediately. If we say "beta", then only after 9 months. However, we have not decided how we label ourselves (i would say, still alpha, but we could also say, the serving part is beta, eventing alpha. It's difficult. :)

@rhuss
Copy link
Contributor

rhuss commented Feb 8, 2020

/retest

rhuss
rhuss approved these changes Feb 8, 2020
View reviewed changes
Copy link
Contributor

@rhuss rhuss left a comment

Choose a reason for hiding this comment

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

/lgtm

@knative-prow-robot knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 8, 2020
@knative-prow-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dsimansk, maximilien, rhuss

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

@knative-prow-robot knative-prow-robot merged commit 8d2ecca into knative:master Feb 8, 2020
rhuss added a commit to rhuss/knative-client that referenced this pull request Feb 19, 2020
@rhuss
chore: Add option to generate frontmatter to gendocs.
210fa2e 
This is needed for latter inclusion in knative.dev. Related to knative#639.
@rhuss rhuss mentioned this pull request Feb 19, 2020
Merged
knative-prow-robot pushed a commit that referenced this pull request Mar 9, 2020
@rhuss
chore: Add option to generate frontmatter to gendocs. (#680)
56e1465 
* chore: Cleaned up README

This is just a start for reorganizing the client side documentation.

* chore: Add option to generate frontmatter to gendocs.

This is needed for latter inclusion in knative.dev. Related to #639.
coryrc pushed a commit to coryrc/client that referenced this pull request May 14, 2020
@chaodaiG @knative-prow-robot
sending slack notification to api channel (knative#639)
c6137af
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@knative-prow-robot knative-prow-robot knative-prow-robot left review comments

@rhuss rhuss rhuss approved these changes

@maximilien maximilien maximilien approved these changes

@evankanderson evankanderson Awaiting requested review from evankanderson

@mattmoor mattmoor Awaiting requested review from mattmoor

Assignees

@rhuss rhuss

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Indicates the PR's author has signed the CLA. lgtm Indicates that a PR is ready to be merged. 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.

Rename --async to --no-wait
6 participants
@dsimansk @knative-metrics-robot @rhuss @knative-prow-robot @maximilien @googlebot