Skip to content

Commit 35dcafb

Browse files
marccampbellk8s-ci-robot
authored andcommitted
docs: Add link to GitHub template repo to developer guide (#323)
* Add link to GitHub template repo to developer guide * Add additional language to make it clear that this is not a krew project
1 parent 08a2071 commit 35dcafb

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/DEVELOPER_GUIDE.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ Before creating a plugin, read the [Kubernetes Plugins documentation][plugins].
3131
designed to provide the same command-line arguments, kubeconfig parser,
3232
Kubernetes API REST client, and printing logic.
3333

34+
**Unofficial Quickstart for Go:** For Go plugins, there's a
35+
[GitHub template repo](https://github.com/replicatedhq/krew-plugin-template)
36+
that implements these best practices and also configures GoReleaser and a
37+
GitHub Action to create releases when a tag is pushed. Note: this template
38+
repo is not maintained by the Krew project.
39+
3440
Below you will create a small plugin named `foo` which prints the environment
3541
variables to the screen and exits.
3642

@@ -192,10 +198,10 @@ wildcard may install more files than desired.
192198
```yaml
193199
files: [{from: "*", to: "."}]
194200
```
195-
201+
196202
This copies out binaries for both platforms to the installation directory
197203
onto the user’s machine, despite only one of them will be used:
198-
204+
199205
```text
200206
.
201207
└── krew-foo-windows.exe
@@ -248,7 +254,7 @@ plugin name.
248254
#### Specifying a plugin download URL
249255

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

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

0 commit comments

Comments
 (0)