Skip to content

Commit

Permalink
Merge branch 'master' into kn-plugins4
Browse files Browse the repository at this point in the history
  • Loading branch information
maximilien committed Jul 22, 2019
2 parents e481fd9 + 75a41de commit 76efc23
Show file tree
Hide file tree
Showing 56 changed files with 1,401 additions and 538 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/ask-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Question
about: Ask a question about knative/client
title: ''
labels: kind/question
assignees: ''

---
<!-- If you need to report a security issue with Knative, send an email to [email protected]. -->
## In what area(s)?

<!-- Remove the '> ' to select -->

<!--
Classifications:
> /kind good-first-issue
> /kind usage
> /kind compatibility
> /kind doc
-->

## Ask your question here:

44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: Bug report
about: Report a bug in knative/client
title: ''
labels: kind/bug
assignees: ''

---
<!-- If you need to report a security issue with Knative, send an email to [email protected]. -->
## In what area(s)?

<!-- Remove the '> ' to select -->

<!--
Classifications:
> /kind good-first-issue
> /kind doc
> /kind cleanup
-->

## What version of Knative Client?

> Paste output of 'kn version'
## What version of Knative Serving running on your cluster?

> 0.5.x
> 0.6.x
> 0.7.x
> 0.8.x
## Expected Behavior

<!-- Briefly describe what you expect to happen -->


## Actual Behavior

<!-- Briefly describe what is actually happening -->


## Steps to Reproduce the Problem

<!-- How can a maintainer reproduce this issue (be detailed) -->
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature Request
about: Create a feature request for knative/client
title: ''
labels: kind/feature
assignees: ''

---
<!-- If you need to report a security issue with Knative, send an email to [email protected]. -->
## In what area(s)?

<!-- Remove the '> ' to select -->

<!--
Classifications:
> /kind good-first-issue
> /kind feature
> /kind proposal
> /kind doc
> /kind cleanup
-->

## Describe the feature:

23 changes: 23 additions & 0 deletions .github/pull-request-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
Request Prow to automatically lint any go code in this PR:
/lint
-->

Fixes #

## Proposed Changes

*
*
*

**Release Note**

<!-- Enter your extended release note in the below block. If the PR requires
additional action from users switching to the new release, include the string
"action required". If no release note is required, write "NONE". -->

```release-note
```
186 changes: 186 additions & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
# Changelog

// Template:
////
[cols="1,10,3", options="header", width="100%"]
|===
| | Description | PR

| 🎁🐛🧽🗑️
|
| https://github.com/knative/client/pull/[#]
|===
////

## v0.8.0 (unreleased)

[cols="1,10,3", options="header", width="100%"]
|===
| | Description | PR

| 🎁
| Wait for service to become ready with `kn service update` (same behaviour as for `kn service create`)
| https://github.com/knative/client/pull/271[#271]

| 🐛
| Better error handling when providing wrong kubeconfig option
| https://github.com/knative/client/pull/222[#222]

|===

## v0.2.0 (2019-07-10)

[cols="1,10,3", options="header", width="100%"]
|===
| | Description | PR

| 🐛
| Show URL instead of address when listing services
| https://github.com/knative/client/pull/247[#247]

| 🎁
| Add `kn service list <svc-name>` and `kn revision list <rev-name>`
| https://github.com/knative/client/pull/150[#150]

| 🐛
| Dynamically set GroupVersionKind via schema lookup
| https://github.com/knative/client/pull/134[#134]

| 🧽
| Introduce a `KnClient` interface
| https://github.com/knative/client/pull/134[#134]

| 🐛
| Retry update operation on an optimistic lock failure
| https://github.com/knative/client/pull/240[#240]

| 🎁
| Add `kn route list`
| https://github.com/knative/client/pull/202[#202]

| 🧽
| Improved error message when no command is given
| https://github.com/knative/client/pull/218[#218]

| 🎁
| Add gotest.tools testing support
| https://github.com/knative/client/pull/218[#218]

| 🎁
| Add second test run against latest released Knative serving version
| https://github.com/knative/client/pull/170[#170]

| 🎁️
| Add `--port` to `kn service create` and `kn service update`
| https://github.com/knative/client/pull/191[#191]

| 🎁
| Add `kn revision delete`
| https://github.com/knative/client/pull/207[#207]

| 🎁
| Add goimport to `build.sh`
| https://github.com/knative/client/pull/186[#186]

| 🧽
| Wait for service to become ready with `kn service create`
| https://github.com/knative/client/pull/156[#156]

| 🎁
| Add shell based smoke tests
| https://github.com/knative/client/pull/183[#183]

| 🧽
| Use current namespace from `.kube/config` as default
| https://github.com/knative/client/pull/172[#172]

| 🧽
| Add `--force` to `kn service create` for replacing existing service
| https://github.com/knative/client/pull/79[#79]

| 🧽
| Add `kn revision list --service <srv>`
| https://github.com/knative/client/pull/194[#194]

| 🧽
| Add success message to `kn service update`
| https://github.com/knative/client/pull/169[#169]

| 🎁
| Add mandatory license check to `build.sh`
| https://github.com/knative/client/pull/187[#187]

| 🎁
| Add Golang based E2E tests
| https://github.com/knative/client/pull/121[#121]

| 🧽
| Rename `kn revision get` to `kn revision list`
| https://github.com/knative/client/pull/180[#180]

| 🧽
| Rename `kn service get` to `kn service list`
| https://github.com/knative/client/pull/179[#179]

| 🧽
| Refactoring to use sub-packages
| https://github.com/knative/client/pull/66[#66]

| 🎁
| Add `--test`, `--fast`, `--update` to `build.sh`
| https://github.com/knative/client/pull/149[#149]

| 🧽️
| Update to Knative serving 0.6.0
| https://github.com/knative/client/pull/129[#129]

| 🎁
| Add Zsh completion
| https://github.com/knative/client/pull/132[#132]


| 🎁
| Add autoscale & concurrency options for `service create` and `service update` (`--min-scale`, `--max-scale`, `--concurrency-limit`, `--concurrency-target`)
| https://github.com/knative/client/pull/157[#157]

| 🎁
| Add `--watch` for `build.sh` to enter a compile-watch loop
| https://github.com/knative/client/pull/160[#160]

|===

## v0.1.0 (2019-05-17)

[cols="1,10,3", options="header", width="100%"]
|===
| | Description | PR

| 🎁
| Add --force for `service create`
| https://github.com/knative/client/pull/79[#79]

| 🐛
| Fix info messages after `service create` and `service delete`
| https://github.com/knative/client/pull/95[#95]

| 🎁
| Add `revision get`
| https://github.com/knative/client/pull/97[#97]

| 🎁
| Add `service get`
| https://github.com/knative/client/pull/90[#90]

|===

'''
_Legend_ : 🎁 Feature - 🐛 Fix - 🧽 Update - 🗑️ Remove

////
---------------------------------------------
Ignore PRs:
12
45
---------------------------------------------
////
2 changes: 1 addition & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ You can link that script into a directory within your search `$PATH`. This allow
* `build.sh` - Compile, test, generate docs and format source code
* `build.sh -f` - Compile only
* `build.sh -f -t` - Compile & test
* `build.sh -u` - Update dependencies before compiling
* `build.sh -c` - Update dependencies, regenerate documentation and format source files
* `build.sh -w` - Enter watch mode for automatic recompilation
* `build.sh -w -t` - Enter watch mode for automatic recompilation & running tests

Expand Down
71 changes: 71 additions & 0 deletions conventions/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Guidelines for `kn` Commands

Commands are generally of the form `kn <resource> <verb>`; the resource kind
forms a command group for all the operations you might want to do with that kind
of resource.

Commands that directly concern more than one resource kind may be categorized
with one of the relevant resources, or may get their own top-level verb
(eg. `connect`).

Top-level commands concerning the operation of `kn` itself, like `help` and
`version` are also okay.

## Resource

The <group>.knative.dev Kind, singluar and lowercase. For example, `service` for
`serving.knative.dev/service` or `trigger` for `eventing.knative.dev/trigger`.

## Verb

If the thing the user's doing can be described by the following commands, these
should be the name of the verb:

* `describe` prints detailed information about a single resource. It can include
status information of related or child resources, too.

* `list` prints summary information about all resources of a type, possibly
filtered by parent or label selector.

* `create` creates a resource. Accepts a `--force` flag to create-or-replace.

* `update` updates a resource based on the changes the user would like to make.

* `delete` deletes a resource

For a given resource there should be parallelism between arguments to `create`
and `update` as much as possible.

Other domain-specific verbs are possible on a case-by-case basis, like
`set-traffic` for a Knative Serving Service.

## Arguments

### Positionals

Where there's a single target resource, the resource name should be a positional
argument. It needs to be of the resource type we're talking about, eg. `kn
revision` subcommands the positional must be naming a revision.

```bash
kn service create foo --image gcr.io/things/stuff:tag
```
In this case `foo` is positional, and refers to the service to create.

### Flags

* `--force` is a flag on all create commands, and will replace the resource if
it already exists (otherwise this is an error). The resource will be *mutated*
to have a spec exactly like the resource that would otherwise be created. It
is not deleted and recreated.

* When a flag sets a particular field on create or update, it should be a short
name for the field, without necessarily specifying how it's nested. For
example, `--image=img.repo/asdf` in Knative Serving sets
`spec.template.containers[0].image`

#### Output

Commands that output information should support `--output` with a shorthand of
`-o` to choose how to frame their output, and `--template` for supplying
templates to output styles that use them.
1 change: 0 additions & 1 deletion docs/cmd/kn.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ Manage your Knative building blocks:

### SEE ALSO

* [kn completion](kn_completion.md) - Output shell completion code (default Bash)
* [kn plugin](kn_plugin.md) - Plugin command group
* [kn revision](kn_revision.md) - Revision command group
* [kn route](kn_route.md) - Route command group
Expand Down
Loading

0 comments on commit 76efc23

Please sign in to comment.