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.

Sign up for GitHub

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

Jump to bottom

Report output: potential updates to "Joi validation failures" output #78

Open
SgtPooki opened this issue Jun 6, 2022 · 0 comments
Open

Report output: potential updates to "Joi validation failures" output #78

SgtPooki opened this issue Jun 6, 2022 · 0 comments
Labels
effort/days exp/intermediate kind/discussion kind/enhancement P3 status/deferred topic/design-ux

Comments

@SgtPooki
Copy link
Member

SgtPooki commented Jun 6, 2022 •
edited
Loading

A few things were mentioned to me by @BigLep:

  • Joi may not be something everyone is familiar with
  • Adding the failure bullet points under the expectation (only during failures obviously) could be more readable.

Example

pinning-service-compliance/nft.storage.md

Lines 43 to 51 in f19db8c

#### Joi validation failures
* "reason" is required
* "code" is not allowed
* "message" is not allowed
* "ok" is not allowed

@SgtPooki SgtPooki changed the title Report output: "Joi validation failures" Report output: potential updates to "Joi validation failures" output Jun 6, 2022
@SgtPooki SgtPooki mentioned this issue Jun 7, 2022
Merged
SgtPooki added a commit that referenced this issue Jun 7, 2022
@SgtPooki
chore: rename and hide joi schema failures when empty
9dfaf6c 
temporary solution until #78 is done
SgtPooki added a commit that referenced this issue Jun 14, 2022
@SgtPooki @lidel
feat: Publish static reports via github pages (#68)
5a6a7f5 
* Update build-and-publish-reports.yml

* Update build-and-publish-reports.yml

* Update build-and-publish-reports.yml

* Update build-and-publish-reports.yml

* Update build-and-publish-reports.yml

* Update build-and-publish-reports.yml

* Update build-and-publish-reports.yml

* Update build-and-publish-reports.yml

* Update build-and-publish-reports.yml

* Update build-and-publish-reports.yml

* attempt to use github cache

* Update build-and-publish-reports.yml

* Update build-and-publish-reports.yml

* Update build-and-publish-reports.yml

* fix: md->html conversion requires extra newline

* fix: render body as multiline json in reports

* chore: remove extraneous comments

* feat: add date and revision to report output

* chore: use more explicit github action job names

* fix: do not squash gh-pages history

* feat: Link to headers from summary, cleanup revision markdown

* fix: attempt to catch git-rev error

* fix: Remove hardcoded delay for pinata

* feat: gh-pages has informative commit messages

* chore: Reports with no changes from previous will create commit

* feat: add report history link

* Also handles failures when there is no git history now

* fix: Remove previous revision from header

* chore: rename and hide joi schema failures when empty

temporary solution until #78 is done

* fix: UX improvement for pass/fail/error icons

fixes #76

* fix: add json identifier to code in markdown

fixes #77

* fix: Error output uses icon and header

It will not show if there are no errors

* feat: fix json highlighting in reports

fixes #77

* style: change body order raw→json→parsed

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

Co-authored-by: Marcin Rataj <[email protected]>
github-actions bot pushed a commit that referenced this issue Jun 14, 2022
@semantic-release-bot
chore(release): 1.0.0 [skip ci]
89f9a25 
## 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))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
effort/days exp/intermediate kind/discussion kind/enhancement P3 status/deferred topic/design-ux
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@SgtPooki