Skip to content
check-circle

GitHub Action

Format Smithy

v1 Latest version

Format Smithy

check-circle

Format Smithy

Format smithy on directory or smithy file and fail if there's any difference

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Format Smithy

uses: necko-actions/format-smithy@v1

Learn more about this action in necko-actions/format-smithy

Choose a version

Format Smithy models

This action allows users to format Smithy models using the Smithy CLI command: smithy format

Basic usage

See action.yml

Format all file in the current working directory :

steps:
  - uses: actions/checkout@v3
  - uses: necko-actions/format-smithy@v1
    with:
      version: "1.33.0"

Change the path in the current working directory, e.g, the directory model :

steps:
  - uses: actions/checkout@v3
  - uses: necko-actions/format-smithy@v1
    with:
      version: "1.33.0"
      path: "model"