https://github.com/kjuly/swift-ci

Some reusable CI Workflows for app development in Swift (also including Objective-C).
https://github.com/kjuly/swift-ci

ci continuous-integration github-action swift swiftlint unit-test workflow

Last synced: about 1 month ago
JSON representation

Some reusable CI Workflows for app development in Swift (also including Objective-C).

• Host: GitHub
• URL: https://github.com/kjuly/swift-ci
• Owner: Kjuly
• License: mit
• Created: 2023-11-29T03:30:19.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-16T08:28:18.000Z (2 months ago)
• Last Synced: 2024-11-16T09:23:48.155Z (2 months ago)
• Topics: ci, continuous-integration, github-action, swift, swiftlint, unit-test, workflow
• Homepage:
• Size: 8.79 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# swift-ci

Some reusable CI Workflows for app development in Swift (also including Objective-C).

## Usage for "unit-tests.yml"

```unit-tests-sample.yml

name: Unit Tests

on:

  push:

  pull_request:

jobs:

  call-reusable-workflow-to-test:

    uses: Kjuly/swift-ci/.github/workflows/unit-tests.yml@main

    with:

      use_xcodebuild: true

      platforms: 'iOS,watchOS,macOS'

    secrets: # Required only if need to access a private repo.

      token: ${{ secrets.YOUR_GITHUB_ACTION_TOKEN }} # Replace the `YOUR_GITHUB_ACTION_TOKEN` with your own.

```

| Options (with) | Type    | Required | Default | Description

| -------------- | ------- | -------- |--- | ---

| os             | string  | false    | "" (auto) | Preferred runner OS, e.g. "macos-latest", "ubuntu-latest".

| use_xcodebuild | boolean | false    | false | Use 'xcodebuild test'; if not, will use 'swift test'.

| platforms      | string  | false    | "iOS" | Paltform destinations to do testing, e.g. "iOS,watchOS,macOS".

| scheme         | string  | false    | (repo name) | The Xcode scheme for testing.

| Secrets (secrets) | Type    | Required | Description

| ----------------- | ------- | -------- | ---

| token             | string  | false    | Github action token secrect, it's required if you need to access a private repo under the same user/org scope.

## Usage for "swift-lint.yml"

```swift-lint-sample.yml

name: Swift Lint

on:

  push:

  pull_request:

    paths:

      - '.swiftlint.yml'

      - '**/*.swift'

jobs:

  call-reusable-workflow-to-swift-lint:

    uses: Kjuly/swift-ci/.github/workflows/swift-lint.yml@main

    with:

      use_default_config: true

      force_exclude: true

```

| Options            | Type    | Required | Default | Description

| ------------------ | ------- | -------- |-------- | ---

| use_default_config | boolean | false    | false   | Whether use the default swiftlint.yml config file.

| force_exclude      | boolean | false    | false   | Whether exclude files in config `excluded` even if their paths are explicitly specified.