Skip to content

Setup Smithy

Actions
Installing a version of Smithy CLI and adding it to the PATH
@necko-tech/setup-smithy-v1.2.0
Latest
Star (8)

Setup Smithy CLI for GitHub Actions

This action provide the following functionality for GitHub Actions users:

  • Installing a version of Smithy CLI and adding it to the PATH
  • Optionally caching the content of maven dependencies (located at ~/.m2/software/amazon/smithy) specified in a smithy-build.json

Basic usage

See action.yml

Running smithy CLI :

steps:
  - uses: actions/checkout@v4
  - uses: necko-actions/setup-smithy@v1
    with:
      version: "1.47.0"
  - run: smithy --version

Cache dependencies :

steps:
  - uses: actions/checkout@v4
  - uses: necko-actions/setup-smithy@v1
    with:
      version: "1.47.0"
      smithy-build: "samples/smithy-build.json"
  - run: smithy build
    working-directory: samples

You can see the example running .github/workflows/test-setup-smithy.yml.

Supported architecture

All architecture released by the Smithy CLI are supported.

Setup Smithy 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

Installing a version of Smithy CLI and adding it to the PATH
@necko-tech/setup-smithy-v1.2.0
Latest

Setup Smithy 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.