feat: jargon artifacts validation pipeline #304
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
huynguyen-hl
requested review from
absoludity,
ldhyen99 and
ashleythedeveloper
absoludity
reviewed
Feb 16, 2025
There was a problem hiding this comment.
Looks excellent @huynguyen-hl . I'm just a bit confused about what is going on in one of the functions below. Can you clarify that for me? Otherwise +1
.github/actions/validate-jargon-artefacts/src/contextValidation.js
Outdated
Show resolved
Hide resolved
…g and improved context validation
absoludity
approved these changes
Feb 18, 2025
ashleythedeveloper
approved these changes
Feb 18, 2025
| * @returns {schemas: {fileName: url}, instances: {fileName: url}} | ||
| */ | ||
|
|
||
| function splitSchemasAndInstances (jsonSchemas) { |
There was a problem hiding this comment.
As @absoludity mentioned, I feel that we should update the naming convention, but it's good enough for now.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this? (check all applicable)
Description
This PR implements the GitHub workflow
jargon-webhookspipeline, which is triggered when a Jargon snapshot is created.To set up the webhook, we need to navigate to the specific domain on the Jargon site where we want to configure it, then set up the GitHub dispatch URL and HTTP headers accordingly. Once configured, every time a snapshot is created, Jargon will send a request to the GitHub API to trigger this pipeline and validate its artifacts.
The
jargon-webhookspipeline leverages thevalidate-jargon-artifactsaction to validate JSON-LD contexts and sample credentials against their respective schemas and contexts used within the credentials. This ensures that we can easily determine whether the generated artifacts are valid before proceeding with their release.Screenshots
Below are some screenshots of my testing for the
jargon-webhookspipeline to ensure it works as expected.Jargon webhook configuration:
Pipeline skipped validation upon receiving a test event:
Sample credential validation failed due to a missing required
issuerproperty:Context validation in the credential failed because the protected term
cnfwas redefined:Context artifact validation failed due to an invalid term ("": ""):
The pipeline detected all failed test cases:
All test cases passed successfully: