https://github.com/thomasmost/quicktype-gha

https://github.com/thomasmost/quicktype-gha

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/thomasmost/quicktype-gha
• Owner: thomasmost
• Created: 2024-05-10T20:08:29.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-14T21:01:39.000Z (6 months ago)
• Last Synced: 2024-05-15T16:43:23.433Z (6 months ago)
• Language: TypeScript
• Size: 714 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# quicktype-gha

A GitHub Action for generating type bindings from JSON schema files

## Inputs

### `source-file`

Schema JSON file to generate type bindings from.

### `out-langs`

Comma-separated list of language extensions to generate bindings for

### `out-dir` (optional)

Directory to output generated bindings to

## Example Usage

You can use this action to generate artifacts with the type bindings in your preferred languages.

For example, you might design a workflow to generate bindings for both TypeScript and Rust, e.g.

```yml

name: Build

on: push

jobs:

  test:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v4

      - name: API Schema

        uses: thomasmost/[email protected]

        with:

          source-file: data_objects/api.schema.json

          out-langs: ts,rs

      - name: Upload files

        uses: actions/upload-artifact@v4

        with:

          name: bindings

          path: |

            ./api.ts

            ./api.rs

```