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

docs: Add link to GitHub template repo to developer guide #323

Merged
merged 2 commits into from
Sep 3, 2019
Merged

docs: Add link to GitHub template repo to developer guide #323

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2e4e62
Add link to GitHub template repo to developer guide
marccampbell Aug 28, 2019
1507a74
Add additional language to make it clear that this is not a krew project
marccampbell Sep 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ Before creating a plugin, read the [Kubernetes Plugins documentation][plugins].
designed to provide the same command-line arguments, kubeconfig parser,
Kubernetes API REST client, and printing logic.

**Unofficial Quickstart for Go:** For Go plugins, there's a
[GitHub template repo](https://github.com/replicatedhq/krew-plugin-template)
that implements these best practices and also configures GoReleaser and a
GitHub Action to create releases when a tag is pushed. Note: this template
repo is not maintained by the Krew project.

Below you will create a small plugin named `foo` which prints the environment
variables to the screen and exits.

Expand Down Expand Up @@ -192,10 +198,10 @@ wildcard may install more files than desired.
```yaml
files: [{from: "*", to: "."}]
```

This copies out binaries for both platforms to the installation directory
onto the user’s machine, despite only one of them will be used:

```text
.
└── krew-foo-windows.exe
Expand Down Expand Up @@ -248,7 +254,7 @@ plugin name.
#### Specifying a plugin download URL

krew plugins must be packaged as `.zip` or `.tar.gz` archives and should be made
available for download publicly.
available for download publicly.
Downloading from a URL also requires a checksum of the downloaded content:

- `uri`: URL to the archive file (`.zip` or `.tar.gz`)
Expand Down