-
Notifications
You must be signed in to change notification settings - Fork 363
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.
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
docs: Add link to GitHub template repo to developer guide #323
Conversation
Welcome @marccampbell! |
Codecov Report
@@ Coverage Diff @@
## master #323 +/- ##
======================================
Coverage 57.3% 57.3%
======================================
Files 19 19
Lines 904 904
======================================
Hits 518 518
Misses 335 335
Partials 51 51 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fits in there nicely. I think we should also link to https://github.com/kubernetes/sample-cli-plugin, but this can be done in another PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
docs/DEVELOPER_GUIDE.md
Outdated
**Quick start 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add a note that this is not maintained by Krew project?
Also we can consider adding Unofficial to the beginning.
Nit: Quick start → Quickstart.
Thanks for the suggestions. Updated the language with the word unofficial and a note that it's not not maintained by the Krew project. |
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ahmetb, marccampbell 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 |
Adding a link to a GitHub template repo for Go projects creating krew plugins. This template has some of the best practices referenced in the guide implemented. The template also has GoReleaser configured to create a release on tag, a basic krew plugin.yaml, and all of the latest k8s client-go dependencies added and configured.
If there's a better place or wording for this, I'm happy to move/change it.