https://github.com/sushichop/gha-swift-env

A GitHub Action that sets up a Swift environment for cross-platform
https://github.com/sushichop/gha-swift-env

actions cmake cross-platform env github-actions ninja swift

Last synced: about 1 month ago
JSON representation

A GitHub Action that sets up a Swift environment for cross-platform

• Host: GitHub
• URL: https://github.com/sushichop/gha-swift-env
• Owner: sushichop
• License: mit
• Created: 2022-02-12T09:11:26.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-10T13:03:36.000Z (almost 2 years ago)
• Last Synced: 2024-09-17T07:07:19.404Z (about 2 months ago)
• Topics: actions, cmake, cross-platform, env, github-actions, ninja, swift
• Language: Shell
• Homepage:
• Size: 37.1 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gha-swift-env

[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-v1-undefined.svg?logo=github&logoColor=white)](https://github.com/marketplace/actions/swift-env)

[![release](https://img.shields.io/github/v/release/sushichop/gha-swift-env.svg?color=blue)](https://github.com/sushichop/gha-swift-env/releases)

![CI](https://github.com/sushichop/gha-swift-env/workflows/CI/badge.svg)

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/sushichop/gha-swift-env/blob/main/LICENSE)

`gha-swift-env` is a GitHub Action that sets up a Swift environment for **cross-platform(macOS, Ubuntu Linux, and Windows)**. 

And it also automatically installs Ninja, which is required for building a Swift code with CMake.

## Usage

You can set the Swift version of the release.

```yaml

- uses: sushichop/gha-swift-env@v1

  with:

    swift-version: '5.6'

- name: Show Swift version and build a Swift package

  run: |

    swift --version

    swift build -v -c release

```

You can also set the Swift version of the snapshot.

```yaml

- uses: sushichop/gha-swift-env@v1

  with:

    swift-version: '2022-07-20-a'

- name: Show Swift version and build a Swift package

  run: |

    swift --version

    swift build -v -c release

```

## Example

You can build and test a Swift package on cross-platform(macOS, Ubuntu Linux, and Windows).

```yaml

on

  pull_request:

jobs:

  swiftpm:

    name: SwiftPM - Swift ${{ matrix.swift-version }} on ${{ matrix.os }}

    runs-on: ${{ matrix.os }}

    strategy:

      matrix:

        os: ['macos-11', 'ubuntu-latest', 'windows-latest']

        swift-version: ['5.6', '2022-07-20-a']

      fail-fast: false

    steps:

      - uses: actions/checkout@v2

      - uses: sushichop/gha-swift-env@V1

        with:

          swift-version: ${{ matrix.swift-version }}

      - name: Build and test a Swift package

        run: |

          swift build -v -c release

          swift test -v -Xswiftc -warnings-as-errors

```

You can also build a Swift package with CMake and Ninja.

```yaml

- uses: sushichop/gha-swift-env@v1

  with:

    swift-version: '5.4.2'

- name: Build with CMake and Ninja

  run: |

    cmake -B ./build -DCMAKE_C_COMPILER=clang -DCMAKE_BUILD_TYPE=RelWithDebInfo -G Ninja -S .

    ninja -C ./build -v

```

## Inputs

- `swift-version` – (required) Swift version to use

  - Specify release or snapshot version

    - `'5.4.2'`, `'5.6'`, `'2022-01-09-a'`, ...

  - Default

    - `'5.4.2'`

    - This value is the minimum Swift version to support Swift 

    package on cross-platform

   

- `winsdk-version` – (optional) WinSDK to use on Windows

  - Specify Windows 10 SDK version

    - `''`, `'10.019041.0'`, `'10.0.20348.0'`, ... 

  - Default:

    - `''`

    - This value(an empty string) sets the default Windows 10 SDK version

## License

`gha-swift-env` is available under the [MIT license](http://www.opensource.org/licenses/mit-license). See the LICENSE file for details.