feat: Publish static reports via github pages #68

SgtPooki · 2022-05-31T23:28:25Z

No description provided.

SgtPooki · 2022-06-01T21:23:03Z

workflow ran successfully for both "schedule", emulated via workflow dispatch, and for PR

see the results at https://ipfs-shipyard.github.io/pinning-service-compliance/

BigLep

You already called out "I’ve gotta fix the rendering for the summary section, I think I just need some extra spacing"

I think the other key thing that would be useful to have in the reports are:

Date that the report was generated. I assume that is gleanable from page history, but it's really useful information to have front and center for someone.
commit of compliance checkeker code that was used (for reproducibilitiy). That said, not required as derivable from the "run date"

.github/workflows/build-and-publish-reports.yml

SgtPooki · 2022-06-02T22:07:10Z

Date that the report was generated. I assume that is gleanable from page history, but it's really useful information to have front and center for someone.

Good idea. I will update to include the date.

.github/workflows/build-and-publish-reports.yml

lidel

Thank you for figuring this out!

Agree with feedback from @BigLep

nft and web3 need to be renamed to include storage suffix
UTC date and version of pinning-service-compliance used for generating the report.

Filled issues for small UX nits: #77 and #76 – these are small enough that you may want to include them here too.

SgtPooki · 2022-06-06T20:42:58Z

@lidel @BigLep check out https://ipfs-shipyard.github.io/pinning-service-compliance/api.estuary.tech.html and current reports if you would. date and revision with link to github commit responsible for report are there now.

BigLep · 2022-06-06T20:51:47Z

@lidel @BigLep check out ipfs-shipyard.github.io/pinning-service-compliance/api.estuary.tech.html and current reports if you would. date and revision with link to github commit responsible for report are there now.

@SgtPooki : cool - great to see! A couple of minor ideas but aren't blocking:

"Date" to "Execution Date" to make it clear what this date is.
"Revision: Revision:" to "Revision:"
Can the summary section be links to the corresponding sections below?
Maybe add a link for how someone can easily see historical run results (I assume a link to the commit history of the page?)

SgtPooki · 2022-06-06T21:00:17Z

@lidel @BigLep check out ipfs-shipyard.github.io/pinning-service-compliance/api.estuary.tech.html and current reports if you would. date and revision with link to github commit responsible for report are there now.

@SgtPooki : cool - great to see! A couple of minor ideas but aren't blocking:

"Date" to "Execution Date" to make it clear what this date is.

Absolutely. quick fix.

"Revision: Revision:" to "Revision:"

oops, good catch

Can the summary section be links to the corresponding sections below?

Yea, that should be easy.. let me give that a go.

Maybe add a link for how someone can easily see historical run results (I assume a link to the commit history of the page?)

historical run results.. that could be useful.. I'm using git-rev from npm currently, and I could easily add a (last report) link.. but linking to previous results would just be linking to the gh-pages branch commit log.

I'm not sure that the s0/git-publish-subdir-action@399aab378450f99b7de6767f62b0d1dbfcb58b53 action keeps history intact though.. and there's no other mechanism. So if gh-pages branch doesn't maintain history, then this feature would be a large effort

SgtPooki · 2022-06-06T21:12:41Z

looks like the publish subdir action will allow you to keep history via SQUASH_HISTORY: https://github.com/s0/git-publish-subdir-action#configuration

BigLep · 2022-06-06T23:18:21Z

Per 2022-06-06 verbal: one other idea is to move the "Joi validation failures" (example) to just be a set of bullets inline under "Response object matches api spec schema (failure)". The reasons for doing this:

It prevents us from rendering "Joi validation failures" when there aren't any
It puts them in context for where they're relevant. Otherwise folks are left wondering, "why are Joi validation failures, why are they relevant?"

* Also handles failures when there is no git history now

SgtPooki · 2022-06-07T20:34:15Z

ok @BigLep @lidel , i made more than a few updates. check out https://ipfs-shipyard.github.io/pinning-service-compliance/api.estuary.tech.html

BigLep · 2022-06-07T21:08:54Z

@SgtPooki : I don't have any comment on the code itself.

Two things:

I see "Previous Revision: (Error getting previous revision)" at the top. Not sure if that's expected. I think jus having a link to the report history is fine without a direct link to the previous revision.
Using https://ipfs-shipyard.github.io/pinning-service-compliance/api.estuary.tech.html#joi-validation-failures-2 as an example, what about renaming "Joi validation failures" to "Response object validation failures with api spec schema" to make it more clear and ideally don't render it if we don't have anything. This seems like something quick/cheap until Report output: potential updates to "Joi validation failures" output #78 is done.

SgtPooki · 2022-06-07T21:33:59Z

I see "Previous Revision: (Error getting previous revision)" at the top. Not sure if that's expected. I think jus having a link to the report history is fine without a direct link to the previous revision.

That is expected, but I can remove it.. because it won't work from NPX nor github actions apparently because checkout only checks out the latest revision. I agree, now that Revision history is there, it's not as useful even if it were to show up

2. Using https://ipfs-shipyard.github.io/pinning-service-compliance/api.estuary.tech.html#joi-validation-failures-2 as an example, what about renaming "Joi validation failures" to "Response object validation failures with api spec schema" to make it more clear and ideally don't render it if we don't have anything. This seems like something quick/cheap until Report output: potential updates to "Joi validation failures" output #78 is done.

What about "Response object doesn't match compliance spec schema:"

SgtPooki · 2022-06-07T21:48:48Z

or "Response object doesn't match expected schema:"

BigLep · 2022-06-07T22:55:35Z

"Response object doesn't match expected schema:" sounds good. It's more clear than "Joi validation failures" :)

temporary solution until #78 is done

fixes #76

fixes #77

It will not show if there are no errors

BigLep

Looks good to me from a presentation side. I didn't review the code.

changes were made

lidel

lgtm, thank you @SgtPooki

Small nit / question below, but ok to merge as-is.

src/output/getReportEntry.ts

.github/workflows/build-and-publish-reports.yml

fixes #77

This makes things easier to reason about: In this order, each step has more strictness.

lidel · 2022-06-14T12:05:31Z

I reordered things in Request/Response section (a5f8eff) but no functional changes.

@SgtPooki merge if it looks ok to you 🚀

## 1.0.0 (2022-06-14) ### Features * add npm bin to devcontainer PATH ([365c142](365c142)) * auto-update github actions with dependabot ([#43](#43)) ([87f7926](87f7926)) * compliance check infrastructure ([7aa5663](7aa5663)) * Export esm module ([#41](#41)) ([acaeac6](acaeac6)) * implement all compliance checks ([#17](#17)) ([1223831](1223831)), closes [#5](#5) [#4](#4) [#6](#6) [#7](#7) [#8](#8) [#28](#28) [#25](#25) * lplaceholder checks run via listr ([bbb1f81](bbb1f81)) * Publish static reports via github pages ([#68](#68)) ([5a6a7f5](5a6a7f5)), closes [#78](#78) [#76](#76) [#77](#77) [#77](#77) ### Bug Fixes * CI release succeeds ([#90](#90)) ([810d4a2](810d4a2)) * Compliance check sum is consistent for all services ([#54](#54)) ([ace2b57](ace2b57)), closes [#55](#55) * devcontainer sees pinning-service-client ([c7a6dbb](c7a6dbb)) ### Trivial Changes * **deps-dev:** bump @types/node from 17.0.25 to 17.0.34 ([#49](#49)) ([a2a5d13](a2a5d13)) * **deps-dev:** bump @types/node from 17.0.35 to 17.0.41 ([#79](#79)) ([db8a6f7](db8a6f7)) * **deps-dev:** bump aegir from 37.0.15 to 37.2.0 ([#86](#86)) ([df4035f](df4035f)) * **deps-dev:** bump ipfs-core-types from 0.10.3 to 0.11.0 ([#64](#64)) ([e623ad3](e623ad3)) * **deps-dev:** bump ts-node from 10.7.0 to 10.8.1 ([#75](#75)) ([ff48f3b](ff48f3b)) * **deps:** bump actions/checkout from 2 to 3 ([#46](#46)) ([8fbbcd8](8fbbcd8)) * **deps:** bump actions/setup-node from 2 to 3 ([#48](#48)) ([ee57c59](ee57c59)) * **deps:** bump github/codeql-action from 1 to 2 ([#47](#47)) ([1dd488d](1dd488d)) * **deps:** bump go-ipfs from 0.12.2 to 0.13.0 ([#80](#80)) ([baaaa8c](baaaa8c)) * **deps:** bump ipfsd-ctl from 10.0.6 to 11.0.1 ([#58](#58)) ([45771db](45771db)) * **deps:** bump lewagon/wait-on-check-action from 0.2 to 1.1.1 ([#44](#44)) ([9c8f5c0](9c8f5c0)) * **deps:** bump node-fetch from 3.2.4 to 3.2.6 ([#81](#81)) ([5bcb760](5bcb760)) * **deps:** bump pascalgn/automerge-action from 0.13.1 to 0.15.3 ([#45](#45)) ([65c19dc](65c19dc)) * getting started instructions ([b7ff148](b7ff148)) * ignore .envrc ([54e5aae](54e5aae)) * static report landing page provides context ([#87](#87)) ([12fc841](12fc841)) * use gitignore.io ([e81ebd9](e81ebd9))

github-actions · 2022-06-14T22:51:50Z

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

SgtPooki added 14 commits May 31, 2022 16:28

Update build-and-publish-reports.yml

91a37f7

Update build-and-publish-reports.yml

b6543ac

Update build-and-publish-reports.yml

34f16fd

Update build-and-publish-reports.yml

95182ee

Update build-and-publish-reports.yml

38e68f9

Update build-and-publish-reports.yml

369c29d

Update build-and-publish-reports.yml

07a9314

Update build-and-publish-reports.yml

3fbf1f7

Update build-and-publish-reports.yml

de1c3d7

Update build-and-publish-reports.yml

59750e5

attempt to use github cache

6bb0d70

Update build-and-publish-reports.yml

081e0a3

Update build-and-publish-reports.yml

2bd87c4

Update build-and-publish-reports.yml

acbccbe

SgtPooki added 2 commits June 1, 2022 14:29

fix: md->html conversion requires extra newline

d08a8f3

fix: render body as multiline json in reports

715e404

BigLep reviewed Jun 2, 2022

View reviewed changes

SgtPooki commented Jun 2, 2022

View reviewed changes

.github/workflows/build-and-publish-reports.yml Outdated Show resolved Hide resolved

lidel previously requested changes Jun 6, 2022

View reviewed changes

SgtPooki added 3 commits June 6, 2022 08:28

chore: remove extraneous comments

2b4ce75

feat: add date and revision to report output

b81ffb2

chore: use more explicit github action job names

7bf0131

fix: do not squash gh-pages history

e62c17d

SgtPooki added 2 commits June 7, 2022 13:01

chore: Reports with no changes from previous will create commit

16a5774

feat: add report history link

eda2a20

* Also handles failures when there is no git history now

fix: Remove previous revision from header

2d1ce30

SgtPooki added 4 commits June 7, 2022 16:27

chore: rename and hide joi schema failures when empty

9dfaf6c

temporary solution until #78 is done

fix: UX improvement for pass/fail/error icons

6e74e3b

fixes #76

fix: add json identifier to code in markdown

0782e44

fixes #77

fix: Error output uses icon and header

933fbc6

It will not show if there are no errors

SgtPooki marked this pull request as ready for review June 8, 2022 19:39

SgtPooki requested review from lidel and BigLep June 8, 2022 19:39

BigLep approved these changes Jun 8, 2022

View reviewed changes

SgtPooki self-assigned this Jun 13, 2022

lidel mentioned this pull request Jun 13, 2022

Highlight JSON in responses #77

Closed

lidel approved these changes Jun 13, 2022

View reviewed changes

src/output/getReportEntry.ts Outdated Show resolved Hide resolved

.github/workflows/build-and-publish-reports.yml Show resolved Hide resolved

SgtPooki and others added 2 commits June 13, 2022 13:41

feat: fix json highlighting in reports

0251812

fixes #77

style: change body order raw→json→parsed

a5f8eff

This makes things easier to reason about: In this order, each step has more strictness.

SgtPooki linked an issue Jun 14, 2022 that may be closed by this pull request

Create static output of pinning service compliance checks #1

Closed

SgtPooki changed the title ~~Update build-and-publish-reports.yml~~ feat: Publish static reports via github pages Jun 14, 2022

SgtPooki merged commit 5a6a7f5 into main Jun 14, 2022

SgtPooki deleted the SgtPooki-patch-1 branch June 14, 2022 18:38

github-actions bot added the released label Jun 14, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Publish static reports via github pages #68

feat: Publish static reports via github pages #68

SgtPooki commented May 31, 2022

SgtPooki commented Jun 1, 2022

BigLep left a comment

SgtPooki commented Jun 2, 2022

lidel left a comment

SgtPooki commented Jun 6, 2022

BigLep commented Jun 6, 2022

SgtPooki commented Jun 6, 2022 •

edited

Loading

SgtPooki commented Jun 6, 2022

BigLep commented Jun 6, 2022

SgtPooki commented Jun 7, 2022

BigLep commented Jun 7, 2022

SgtPooki commented Jun 7, 2022

SgtPooki commented Jun 7, 2022

BigLep commented Jun 7, 2022

BigLep left a comment

lidel left a comment

lidel commented Jun 14, 2022

github-actions bot commented Jun 14, 2022

feat: Publish static reports via github pages #68

feat: Publish static reports via github pages #68

Conversation

SgtPooki commented May 31, 2022

SgtPooki commented Jun 1, 2022

BigLep left a comment

Choose a reason for hiding this comment

SgtPooki commented Jun 2, 2022

lidel left a comment

Choose a reason for hiding this comment

SgtPooki commented Jun 6, 2022

BigLep commented Jun 6, 2022

SgtPooki commented Jun 6, 2022 • edited Loading

SgtPooki commented Jun 6, 2022

BigLep commented Jun 6, 2022

SgtPooki commented Jun 7, 2022

BigLep commented Jun 7, 2022

SgtPooki commented Jun 7, 2022

SgtPooki commented Jun 7, 2022

BigLep commented Jun 7, 2022

BigLep left a comment

Choose a reason for hiding this comment

lidel left a comment

Choose a reason for hiding this comment

lidel commented Jun 14, 2022

github-actions bot commented Jun 14, 2022

SgtPooki commented Jun 6, 2022 •

edited

Loading