Skip to content

Commit

Permalink
Document strict mode in README.md (ko-build#126)
Browse files Browse the repository at this point in the history
  • Loading branch information
imjasonh authored and jonjohnsonjr committed Jan 27, 2020
1 parent 99ecfeb commit f12b9e6
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,19 @@ of convenience for cleaning up resources created through `ko apply`.

`ko version` prints version of ko. For not released binaries it will print hash of latest commit in current git tree.

### Strict Mode

It can be difficult for `ko` to determine whether a string in a YAML file is
intended to be an import path, due to typos, non-`package main` packages, and
conflicts between import paths and common strings (e.g., a package whose
import path is `busybox`). To solve this, `ko` supports "Strict Mode".

When referencing an import path in the YAML file, prefix the string with
the string `ko://` (e.g., `ko://github.com/my/repo/cmd/foo`). Then, when
calling `ko apply` or `ko resolve`, pass `--strict`. If a string
with the `ko://` prefix is not determined to be a valid import path, the
command will fail, rather than passing it through to the resolved YAML.

## With `minikube`

You can use `ko` with `minikube` via a Docker Registry, but this involves
Expand Down

0 comments on commit f12b9e6

Please sign in to comment.