CI build matrix & selected repo statistics

[harlantwood]

Moving over from: ipfs/infra#25

OK, I'm going to take a stab at a fully client-side build monitor tool that can run from IPFS.

updated to incorporate jbenet items from a comment below:

Features:

• makes a simple table, a bit like http://ethereum-buildboard.meteor.com/
• hits the github API and gets a list of all public repos within https://github.com/ipfs/
• makes a table with a row for each repo
• make repo name a link to repo
• CI status:
  • Travis (with link)
  • Circle CI (with link)
• readme is > 500 chars in length
• readme contains:
  • circle-ci badge
  • travis-ci badge
  • contribute to IPFS badge
  • "made by" badge
  • IRC badges
  • see also Repository creation and readme conformity guidelines ipfs/community#45

Deployment:

• first, run on github pages as POC
• run on IPFS

Meta:

• list API requests used/remaining in current time window

[harlantwood]

We now read all readmes from all repos. I've added a check / x if readme is present or not; next step is to parse them to look for status badges etc.

[harlantwood]

latest: https://ipfs.io/ipfs/QmTD5wsY5uj8jReARqSdRW2DUyRMAWW9md5oiB6j5vACcX/

backup: http://ipfs.github.io/ci-status/

[RichardLitt]

We now read all readmes from all repos. I've added a check / x if readme is present or not; next step is to parse them to look for status badges etc.

Doesn't this technically grab the repo name and check against travis, or does this actually parse the README files? If so, can you point me to that?

[harlantwood]

@RichardLitt it does fetch the full text of the readme's -- not parsing them yet, but just about to start 😄

the repo.readmeText is the animal in question, eg: https://github.com/ipfs/ci-status/blob/21eedb32c78d0cee6ed035bf43b80e72f2211a3b/src/index.coffee#L46

[jbenet]

@harlantwood may be good to have multiple columns for readme:

• has circle-ci badge
• has travis-ci badge
• has contribute to IPFS badge
• has ... (all the badges)
• is > 500 chars in length

Also would be good:

• of open issues / # of total issues (e.g. 5/12)

• of open PRs / # of total issues

• make repo name a link to repo
• if repo not enabled in ci, add direct link to enable? (makes it fast to click all)
• repo has contribute.md as well
• repo has LICENSE
• repo has PATENTS (need to add this file everywhere)

[harlantwood]

@jbenet great list, thanks.

@RichardLitt we are now actually parsing the readme and looking for certain buttons: https://github.com/ipfs/ci-status/blob/515a2bbe1e289fb864e07a99d7fdb6477f8c987e/src/index.coffee#L63

I added some datatable styling as well, to make it more readable.

Latest: http://ipfs.github.io/ci-status/

[harlantwood]

@jbenet I moved your ideas into the checklist at the top: #1 (comment)

[harlantwood]

looking awesome : ) http://ipfs.github.io/ci-status/ -- still things left to do, but wanted to share : )

[dignifiedquire]

@harlantwood blank screen in chrome atm :(

[dignifiedquire]

[harlantwood]

yeah, thanks, github is throttling api requests... I filed a bug : ( #5

here is a screenshot of the latest in the meantime...

[jbenet]

that looks great! thanks for screenshot

[harlantwood]

There is still work to do in this story. I added a help wanted tag in case anyone wants to jump in; happy to do some more work myself, and/or help others contribute.

It would be interesting to know:

• what is highest priority of the remaining stories in the checklist above: CI build matrix & selected repo statistics #1 (comment)
• is this page useful to people? who is using it, how, why?
• do we have a good way to track page views for other sites, eg a preferred analytics system?

@RichardLitt @jbenet

[RichardLitt]

Definitely more we can do here.

Regarding priority, I'm not sure, because I don't know who is using this. I can use it more to figure out how to keep IPFS repos up to date, but I haven't been doing that enough. Thank you for the reminder. I would like Contribute, patents, and the stars // issue counts.

I don't know the best way to track pageviews; I believe we could use google analytics. @dignifiedquire Do you know?

[RichardLitt]

@harlantwood Might be a smart idea to split up this issue into a few different issues? It's hard for me to keep track of what is needed and what isn't.

[dignifiedquire]

@RichardLitt google analytics is possible, there are others like mixpanel I like a bit more as it is much easier to get understandable data out of it.

[harlantwood]

Looks like we're using google analytics on https://ipfs.io/ ; I'd suggest we use whatever is most "standard" for us already.

[harlantwood]

@RichardLitt I'm open to spinning off into other issues. Right now it's all in one checklist in the top comment. Feel free to split things out if inspired.

[harlantwood]

I split the remaining items out into their own issues. Closing this one!