Add script to generate plugin overview page #260

corneliusweig · 2019-07-16T09:05:41Z

Close #258

codecov-io · 2019-07-16T09:08:58Z

Codecov Report

Merging #260 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #260   +/-   ##
=======================================
  Coverage   55.66%   55.66%           
=======================================
  Files          19       19           
  Lines         918      918           
=======================================
  Hits          511      511           
  Misses        355      355           
  Partials       52       52

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8867a94...5f8e809. Read the comment docs.

ahmetb · 2019-07-16T20:58:13Z

hack/generate-plugin-overview.go

+}
+
+func printTableHeader(out io.Writer) {
+	printRow(out, "Name", "Description", "GitHub Stars")


Can I recommend actually spitting out html tables?
It's often much better to have html tables in .md files as they're more reliable and bring more freedom that probably will be necessary in the future.

Sure. However, this also means that we should also translate the markdown used in some of the short-descriptions into html. I think a common choice for that task is blackfriday (used by hugo for example).

I think this cmd/foo tool can even have its own go.mod. :)

ahmetb · 2019-07-16T20:58:48Z

Do you think we can have this in cmd/[name]/ instead ?

corneliusweig · 2019-07-16T21:30:35Z

Do you think we can have this in cmd/[name]/ instead ?

Yeah why not.

ahmetb · 2019-07-24T21:10:39Z

Let's move this PR forward by moving the file to cmd/gen-plugin-list/main.go

corneliusweig · 2019-07-24T22:04:44Z

Let's move this PR forward by moving the file to cmd/gen-plugin-list/main.go

Moving the file was not the problem, converting the table to html was. I didn't really find a clean solution here to prevent blackfriday from wrapping its output in <p>-tags. I ended up replacing those via a regex.

ahmetb · 2019-07-24T22:34:50Z

🤔 lets keep .md, then.

This prepares to add additional dependencies to plugin-overview

corneliusweig · 2019-07-25T08:53:19Z

Ok, I reverted to the pure markdown version again.

ahmetb · 2019-07-25T16:59:27Z

cmd/plugin-overview/go.mod

+	sigs.k8s.io/krew v0.2.1
+)
+
+replace sigs.k8s.io/krew => ../..


I am suspecting this would cause issues if I go to a computer and cleanly do sigs.k8s.io/krew/cmd/plugin-overview.

Yes, probably. The problem is that I want to use the homepage field, which was added after the last krew release.
I pinned the import to the current master HEAD instead, to solve the issue you raised.

ahmetb · 2019-07-25T16:59:50Z

cmd/plugin-overview/go.mod

@@ -0,0 +1,12 @@
+module sigs.k8s.io/krew/cmd/plugin-overview


let's call this gen-plugin-overviews or generate-.
otherwise this tool's name is unclear about what it does.

ahmetb · 2019-07-25T17:00:38Z

cmd/plugin-overview/plugin-overview.go

+)
+
+func main() {
+	pluginsDir := pflag.String("plugins-dir", "", "The directory containing the plugin manifests")


do you get much out of pflag vs stdlib pkg/flags here?

No. This is a leftover from when this tool was not its own module.
Only the usage output looks a bit weird when using vanilla flags, though.

I wouldn't worry about usage as it's not a primary tool.

I see your point now. glog hijacks the flags smh.

- rename to `generate-plugin-overview` - pin krew import to specific version - use vanilla flag instead of pflag

ahmetb · 2019-07-25T19:51:27Z

cmd/generate-plugin-overview/go.mod

+require (
+	github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b
+	github.com/pkg/errors v0.8.1 // indirect
+	sigs.k8s.io/krew v0.2.2-0.20190724210953-8867a94acd6d


funny enough this doesn't build from root

$ go build ./cmd/generate-plugin-overview go: finding sigs.k8s.io/krew/cmd/generate-plugin-overview latest go: finding sigs.k8s.io/krew/cmd latest can't load package: package sigs.k8s.io/krew/cmd/generate-plugin-overview: unknown import path "sigs.k8s.io/krew/cmd/generate-plugin-overview": cannot find module providing package sigs.k8s.io/krew/cmd/generate-plugin-overview

but if you ./cmd/generate-plugin-overview then go build . it works haha.

cmd/generate-plugin-overview/generate-plugin-overview.go

ahmetb · 2019-07-25T19:58:37Z

cmd/generate-plugin-overview/generate-plugin-overview.go

+	"regexp"
+	"strings"
+
+	"github.com/golang/glog"


maybe don't import glog (and just use log.Printf+os.Exit) if it helps you avoid glog hijacking flags

I tried, but it didn't really work. It's fine either way. As you said, the tool is just a little helper.

ahmetb · 2019-07-25T20:00:15Z

I just tried and I like it!

Do you envision we would require the output file on krew-index repository to be up to date (as a travis check) or should we update it ourselves periodically? Earlier option sounds like it's a burden during onboarding new plugins.

cmd/generate-plugin-overview/generate-plugin-overview.go

- Change header - Add footer - switch from `glog` to vanilla `log` - change label for stars

corneliusweig · 2019-07-25T22:34:53Z

Do you envision we would require the output file on krew-index repository to be up to date

I wouldn't be so strict about the overview. Initially, manual sounds right, as there is

a) not so many new plugins
b) we may not keep the page

In the long run, my favorite solution would be to let a hook add additional commits, when the overview has changed. Or at least, a PR for the change is created. But that sounds like more work than we are saving for a long time.

ahmetb · 2019-07-25T22:46:43Z

Thanks for developing this.
/lgtm
/approve

I'm thinking we host this on krew main repo docs/plugins.md and link from the main README.md, but we can also go with krew-index (just that it ships to everyone’s machine is my only concern, but this is a small file anyway).

k8s-ci-robot · 2019-07-25T22:46:49Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahmetb, corneliusweig

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:

~~OWNERS~~ [ahmetb,corneliusweig]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot requested review from ahmetb and juanvallejo July 16, 2019 09:05

k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 16, 2019

ahmetb reviewed Jul 16, 2019

View reviewed changes

corneliusweig added 2 commits July 24, 2019 23:15

Add script to generate plugin overview page

8a2f177

Move plugin-overview.go to cmd/plugin-overview

84aff89

corneliusweig force-pushed the w/plugin-overview branch from d2699d9 to 22e7385 Compare July 24, 2019 22:00

Decouple plugin-overview module from main krew

a6fecb6

This prepares to add additional dependencies to plugin-overview

corneliusweig force-pushed the w/plugin-overview branch from 22e7385 to a6fecb6 Compare July 25, 2019 08:52

ahmetb reviewed Jul 25, 2019

View reviewed changes

Review comments

9107884

- rename to `generate-plugin-overview` - pin krew import to specific version - use vanilla flag instead of pflag

ahmetb reviewed Jul 25, 2019

View reviewed changes

cmd/generate-plugin-overview/generate-plugin-overview.go Outdated Show resolved Hide resolved

ahmetb reviewed Jul 25, 2019

View reviewed changes

cmd/generate-plugin-overview/generate-plugin-overview.go Outdated Show resolved Hide resolved

ahmetb reviewed Jul 25, 2019

View reviewed changes

cmd/generate-plugin-overview/generate-plugin-overview.go Show resolved Hide resolved

Review comments

5f8e809

- Change header - Add footer - switch from `glog` to vanilla `log` - change label for stars

k8s-ci-robot assigned ahmetb Jul 25, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 25, 2019

k8s-ci-robot merged commit 38672e5 into kubernetes-sigs:master Jul 25, 2019

corneliusweig mentioned this pull request Jul 31, 2019

Add plugin overview page #303

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add script to generate plugin overview page #260

Add script to generate plugin overview page #260

corneliusweig commented Jul 16, 2019

codecov-io commented Jul 16, 2019 •

edited

Loading

ahmetb Jul 16, 2019

corneliusweig Jul 16, 2019

ahmetb Jul 16, 2019

ahmetb commented Jul 16, 2019

corneliusweig commented Jul 16, 2019

ahmetb commented Jul 24, 2019

corneliusweig commented Jul 24, 2019

ahmetb commented Jul 24, 2019

corneliusweig commented Jul 25, 2019

ahmetb Jul 25, 2019

corneliusweig Jul 25, 2019

ahmetb Jul 25, 2019

ahmetb Jul 25, 2019

corneliusweig Jul 25, 2019

ahmetb Jul 25, 2019

ahmetb Jul 25, 2019

ahmetb Jul 25, 2019

ahmetb Jul 25, 2019

corneliusweig Jul 25, 2019

ahmetb commented Jul 25, 2019

corneliusweig commented Jul 25, 2019

ahmetb commented Jul 25, 2019

k8s-ci-robot commented Jul 25, 2019

Add script to generate plugin overview page #260

Add script to generate plugin overview page #260

Conversation

corneliusweig commented Jul 16, 2019

codecov-io commented Jul 16, 2019 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmetb commented Jul 16, 2019

corneliusweig commented Jul 16, 2019

ahmetb commented Jul 24, 2019

corneliusweig commented Jul 24, 2019

ahmetb commented Jul 24, 2019

corneliusweig commented Jul 25, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmetb commented Jul 25, 2019

corneliusweig commented Jul 25, 2019

ahmetb commented Jul 25, 2019

k8s-ci-robot commented Jul 25, 2019

codecov-io commented Jul 16, 2019 •

edited

Loading