TypeMorph Schema Check · Actions · GitHub Marketplace · GitHub
Skip to content
Search or jump to...
Search code, repositories, users, issues, pull requests...
-->
Search
Clear
Search syntax tips
Provide feedback
--><br>We read every piece of feedback, and take your input very seriously.
Include my email address so I can be contacted
Cancel
Submit feedback
Saved searches
Use saved searches to filter your results more quickly
-->
Name
Query
To see all available qualifiers, see our documentation.
Cancel
Create saved search
Sign in
Sign up
Appearance settings
Resetting focus
You signed in with another tab or window. Reload to refresh your session.<br>You signed out in another tab or window. Reload to refresh your session.<br>You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
{{ message }}
TypeMorph Schema Check<br>Actions
About
Grade schema quality, detect breaking changes, and convert schemas in CI<br>v1.0.0<br>Latest
By yhan86818-creator
Star0 (0)You must be signed in to star a repositoryUse latest version<br>Choose a version
Tags<br>2 (2)<br>continuous-integrationcode-quality
TypeMorph Schema Check
GitHub Action for schema quality grading and breaking change detection — powered by TypeMorph.
Usage
Grade schema quality
- uses: yhan86818-creator/typemorph-action@v1<br>with:<br>command: quality<br>file: openapi.yaml<br>min-grade: B # fail the pipeline if any schema grades below B
Detect breaking changes
- uses: yhan86818-creator/typemorph-action@v1<br>with:<br>command: diff<br>old-file: /tmp/schema-base.json<br>new-file: schema.json
Full workflow example
/tmp/base.yaml<br>- uses: yhan86818-creator/typemorph-action@v1<br>with:<br>command: diff<br>old-file: /tmp/base.yaml<br>new-file: openapi.yaml">name: Schema Check<br>on:<br>pull_request:<br>paths: ['**.json', '**.yaml']
jobs:<br>schema:<br>runs-on: ubuntu-latest<br>steps:<br>- uses: actions/checkout@v4<br>with:<br>fetch-depth: 0
- name: Quality check<br>uses: yhan86818-creator/typemorph-action@v1<br>with:<br>command: quality<br>file: openapi.yaml<br>min-grade: B
- name: Breaking change check<br>run: git show origin/${{ github.base_ref }}:openapi.yaml > /tmp/base.yaml<br>- uses: yhan86818-creator/typemorph-action@v1<br>with:<br>command: diff<br>old-file: /tmp/base.yaml<br>new-file: openapi.yaml
Inputs
Input<br>Description<br>Required<br>Default
command<br>quality or diff<br>quality
file<br>Schema file path (quality)
old-file<br>Old schema file (diff)
new-file<br>New schema file (diff)
min-grade<br>Minimum grade: A, B, C, D, F
schema<br>Target a specific named schema
breaking-only<br>Only report breaking changes<br>false
post-comment<br>Post results as PR comment<br>true
token<br>GitHub token<br>${{ github.token }}
Outputs
Output<br>Description
grade<br>Worst schema grade (A–F)
score<br>Quality or compatibility score (0–100)
breaking<br>Number of breaking changes
passed<br>true / false
PR Comment
The action automatically posts a comment on every PR:
Quality check:
Schema<br>Grade<br>Score<br>Top Issue
User<br>🟢 A<br>94/100
Product<br>🟡 C<br>68/100<br>Has any type
Breaking change check:
Schema<br>Status<br>Breaking<br>Warnings
User<br>✅ Clean
Product<br>❌ Breaking
Supports
JSON, YAML, OpenAPI 3.x, JSON Schema
Multi-schema OpenAPI files (grades every component independently)
160+ output formats via typemorph-cli
Powered by TypeMorph · npm
Resources
Open an issue0 (0)<br>Pull requests0 (0)<br>View source code<br>Report abuse
TypeMorph Schema Check is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
About
Grade schema quality, detect breaking changes, and convert schemas in CI<br>v1.0.0<br>Latest
By yhan86818-creator
Tags<br>2 (2)<br>continuous-integrationcode-quality
Resources
Open an issue0 (0)<br>Pull requests0 (0)<br>View source code<br>Report abuse
TypeMorph Schema Check is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
You can’t perform that action at this time.