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.

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

feat: generate the Dashboard - base structure #152

Merged
merged 17 commits into from
Sep 6, 2023

Conversation

laurentsenta
Copy link
Contributor

@laurentsenta laurentsenta commented Aug 25, 2023

example output:
https://singulargarden.github.io/gateway-conformance/

example workflow:
https://github.com/singulargarden/gateway-conformance/actions/workflows/deploy-pages.yml

Adds data generation

  • munge.js: takes a go test output and generates a nicer data structure
  • munge_sql.js: load all the outputs into a single sqlite db
  • munge_aggregates.js: generate resources for the website generation (content pages and data files)

Generate the dashboard

  • in www/
  • using Hugo

Follow-ups (see #123)

  • complete drill down (fix slugs, pathing, and breadcrumbs)
  • complete logs rendering (nesting for logs)
  • more prominent jobs urls

@laurentsenta laurentsenta marked this pull request as draft August 25, 2023 08:18
@laurentsenta laurentsenta changed the title feat: generate most of the dashboard feat: Generate the Dashboard - base structure Aug 25, 2023
@laurentsenta laurentsenta changed the title feat: Generate the Dashboard - base structure feat: generate the Dashboard - base structure Aug 25, 2023
Copy link
Contributor

@galargh galargh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, I didn't review SQL too closely - assuming it's OK if it works. And HTML, I'd say that the visual review we did together during demo last time is good enough. All in all, good to go from my side :)

.github/workflows/deploy-pages.yml Show resolved Hide resolved
.github/workflows/deploy-pages.yml Show resolved Hide resolved
munge.js Show resolved Hide resolved
munge.js Show resolved Hide resolved
munge.js Show resolved Hide resolved
munge_aggregates.js Show resolved Hide resolved
munge_sql.js Show resolved Hide resolved
munge_sql.js Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
www/themes/conformance/package.json Outdated Show resolved Hide resolved
@laurentsenta laurentsenta marked this pull request as ready for review September 1, 2023 13:51
@BigLep
Copy link

BigLep commented Sep 4, 2023

Very nice!

A few things coming to mind:

  1. Do we have docs describing the flow of the dashboard generation? For example, I can't remember, are we pulling the conformance results from the CIs of other projects (like Kubo, Boxo) or are we running the conformance tests ourselves in this repo? (it looks like we pull the results per https://github.com/singulargarden/gateway-conformance/actions/runs/6075886236 ). It would be good to have docs on "how to add your implementation to the dashboard". I think that will cause the right high level info to surface.
  2. Assuming we're pulling results from other repos, what's the way for someone to see:
    • what commit of the conformance test suite we ran
    • what commit of the implementation we ran against
    • date when these results are from
      Is that all in the job log?

Good stuff.

I would also talk with @lidel on how we give visibility to this dashboard from https://specs.ipfs.tech/

@laurentsenta laurentsenta merged commit fd7e8c9 into main Sep 6, 2023
13 of 16 checks passed
@laurentsenta
Copy link
Contributor Author

@BigLep thanks for the nice and detailed feedback, I'll update #123 to take into account your notes.

@github-actions github-actions bot mentioned this pull request Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants