GitHub Actions

This repository contains reusable GitHub Actions to streamline workflows for code quality checks and Xcode build/testing. These actions can be easily integrated into your workflows to ensure consistent quality and testing processes.

Actions in this Repository

1. Code Quality with Ktlint

Description

This action runs code quality checks using Ktlint, a Kotlin linter and formatter. It helps maintain clean and consistent code styles in your Kotlin projects.

Inputs

No inputs are required.

Usage

Below is an example workflow using the Code Quality with Ktlint action:

name: Code Quality Check

on:
  pull_request:
    branches:
      - main

jobs:
  ktlint-check:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Run Ktlint
        uses: mtdtechnology-net/github-actions/.github/actions/ktlint@1.0.4/

2. Xcode Test Runner

Description

This action runs Xcode builds and tests using the xcodebuild command. It is designed to work with iOS projects and ensures automated testing through GitHub Actions.

Inputs

Input	Description	Required	Default
`scheme`	The scheme to build and test	Yes	N/A
`project`	The project file path	Yes	N/A
`device`	The iOS Simulator device name	No	`iPhone 16`
`os`	The iOS Simulator OS version	No	`18.0`
`testPlan`	The test plan to use	Yes	N/A

Usage

Below is an example workflow using the Xcode Test Runner action:

name: Run Xcode Tests

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  xcode-tests:
    runs-on: macos-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Run Xcode Tests
        uses: mtdtechnology-net/github-actions/.github/actions/xcode-test@1.0.4/
        with:
          scheme: "YourScheme"
          project: "YourProject.xcodeproj"
          device: "iPhone 16"
          os: "18.0"
          testPlan: "YourTestsPlan"
          enableCodeCoverage: "YES"

3. Xcodebuild SPM Test Action

This reusable GitHub Action is designed to run tests for Swift Package Manager or Xcode projects using the xcodebuild command. It supports specifying the scheme, device, OS version, and the directory containing the project.

Inputs

Input Name	Required	Description	Example
`scheme`	Yes	The Xcode scheme to build and test.	`YourScheme`
`device`	Yes	The device to use for the test destination.	`iPhone 16`
`os`	Yes	The OS version to use for the test destination.	`16.0`
`path`	Yes	The path to the Swift Package or Xcode project (relative to the repository root).	`/PathToSPM`

Outputs

Output Name	Description
`test-result`	The result of the `xcodebuild` command.

Usage

Below is an example of how to use the reusable action in a workflow file:

name: Run Xcode Tests

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  run-tests:
    runs-on: macos-latest

    steps:
      - name: Run Tests Using Xcodebuild Action
        uses: mtdtechnology-net/github-actions/.github/actions/run-xcodebuild-tests@1.0.4
        with:
          scheme: "YourScheme"            
          device: "iPhone 16"        
          os: "16.0"
          path: "/PathToYourSPM"
          enableCodeCoverage: "YES"

4. Code Quality with SwiftLint

Description

This action runs code quality checks using SwiftLint, a linter and style checker for Swift. It ensures clean and consistent code styles in your Swift projects by identifying and enforcing Swift best practices.

Inputs

Input Name	Description	Required	Default
`arguments`	Additional arguments to customize the SwiftLint command (e.g., `--strict`, `--reporter json`).	No	`''` (none)

Usage

Below is an example workflow using the Code Quality with SwiftLint action:

name: Code Quality Check

on:
  pull_request:
    branches:
      - main

jobs:
  swiftlint-check:
    runs-on: macos-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Run SwiftLint
        uses: mtdtechnology-net/github-actions/.github/actions/swiftlint@1.0.4
        with:
          arguments: '--strict'

Example Arguments

You can pass additional arguments to customize SwiftLint's behavior:

--strict: Enforce stricter lint rules.
--reporter json: Output results in JSON format.

SwiftLint Configuration

This action will automatically detect a .swiftlint.yml configuration file in your repository. Ensure the file exists and is properly configured for your project's linting needs.

Benefits

Helps maintain clean and consistent Swift code style.
Automates SwiftLint checks in CI workflows.
Configurable through .swiftlint.yml and arguments for flexibility.

Example Workflow for Changed Files Only

To lint only files changed in a pull request, you can use:

jobs:
  swiftlint-check:
    runs-on: macos-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Run SwiftLint on Changed Files
        uses: mtdtechnology-net/github-actions/.github/actions/swiftlint@1.0.4
        with:
          arguments: '--strict'

This ensures efficient linting for incremental changes.

How It Works

Navigate to the Target Directory:
- The action dynamically navigates to the directory specified in the path input.
Run Tests with Xcodebuild:
- The xcodebuild command is executed with the provided scheme, device, and os.

5. Cleanup Workspace

Description

This action performs cleanup of the GitHub Actions workspace by removing all files and directories. It ensures a clean slate for subsequent steps in the workflow.

Inputs

This action does not require any inputs.

Usage

Below is an example workflow using the Cleanup Workspace action:

name: Cleanup Workspace

on:
  pull_request:
    branches:
      - main

jobs:
  cleanup-job:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - name: Cleanup Workspace
        uses: mtdtechnology-net/github-actions/.github/actions/cleanup@1.0.7

Benefits

Ensures a Clean Workspace: Removes all files and directories in the github.workspace to avoid interference between workflow steps.
Simple and Efficient: Runs a single rm -rf command to clean the workspace.

How It Works

Cleanup Command:
- The action executes the rm -rf command to remove all files and folders from the workspace.
Reusable in Any Workflow:
- The action can be used in any job where a clean workspace is needed.

6. Slack Notification

Description

This action sends Slack notifications using a predefined reusable workflow. It can notify team members about build statuses, deployments, or any other events in your GitHub Actions workflows.

Inputs

Input Name	Description	Required	Type
`status`	The status of the build (e.g., success, failure).	Yes	string
`message`	A custom message to include in the notification.	Yes	string
`url`	A URL to include in the notification (e.g., a PR or commit URL).	Yes	string

Usage

Below is an example workflow using the Slack Notification reusable action:

name: Notify Slack

on:
  push:
    branches:
      - main

jobs:
  notify-slack-job:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - name: Notify Slack
        uses: org-name/shared-workflows/.github/workflows/slack-notification.yml@1.0.9
        with:
          status: success
          message: "Build and test completed for branch: ${{ github.ref_name }}"
          url: ${{ github.event.head_commit.url }}

Benefits

Keeps Teams Updated: Sends real-time notifications to Slack channels about workflow statuses.
Highly Customizable: Allows you to specify custom messages, build statuses, and URLs.
Reusable Across Workflows: Centralizes Slack notifications in a single reusable action.

How It Works

Slack Webhook Setup:
- Uses an Incoming Webhook to send messages to a specific Slack channel.
- Requires a Slack Webhook URL stored as a GitHub secret (SLACK_WEBHOOK_URL).
Dynamic Inputs:
- Accepts status, message, and url inputs to generate detailed and actionable Slack notifications.
Reusable in Any Workflow:
- The action can be called from multiple repositories or workflows, ensuring consistent notifications.

7. Xcov

Description

This action generates code coverage after running tests in your Xcode project and validates the result against a specified coverage threshold.

Inputs

Input Name	Description	Required	Type
`scheme`	The Xcode scheme used to build and test.	Yes	string
`project`	The Xcode project to build and test.	Yes	string
`coverage`	Minimum coverage threshold to validate against.	Yes	string

Usage

Below is an example workflow using the Xcov reusable action:

name: Generate Code Coverage

on:
  pull_request:
    branches:
      - main

jobs:
  generate-coverage-job:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - name: Install Dependencies
        run: |
          sudo gem install bundler
          bundle install

      - name: Generate Code Coverage
        uses: org-name/shared-workflows/.github/workflows/generate-coverage.yml@1.0.0
        with:
          scheme: "MyAppScheme"
          project: "MyApp.xcodeproj"
          coverage: "80"

8. API Key

Description

This action gets an API key from the environment and creates a JSON file out of it.

Usage

jobs:
  generate-api-key:
    runs-on: ubuntu-latest

    steps:
      - name: Generate API Key
        uses: mtdtechnology-net/github-actions/.github/actions/api-key@1.0.0

9. Fastlane Build Number

Description

This action increments the build number for an Xcode project starting from a predefined one.

Inputs

Input Name	Description	Required	Default
`project`	The Xcode project to increment build number for	Yes	N/A
`build_number`	Current build number	Yes	N/A

Usage

jobs:
  increment-build-number:
    runs-on: ubuntu-latest

    steps:
      - name: Increment Build Number
        uses: mtdtechnology-net/github-actions/.github/actions/fastlane-build-number@1.0.0
        with:
          project: "YourProject.xcodeproj"
          build_number: "100"

10. Fastlane Build Release

Description

This action runs the build_release lane for an iOS application using Fastlane.

Inputs

Input Name	Description	Required	Default
`scheme`	Xcode scheme	Yes	N/A
`keychain_password`	Build machine keychain password	Yes	N/A
`keychain_path`	Build machine keychain path	Yes	N/A
`app_id`	iOS App Identifier	Yes	N/A
`provisioning_profile`	iOS App Provisioning profile (starts with `match...`)	Yes	N/A

Usage

jobs:
  build-release:
    runs-on: macos-latest

    steps:
      - name: Build Release
        uses: mtdtechnology-net/github-actions/.github/actions/fastlane-build-release@1.0.0
        with:
          scheme: "YourScheme"
          keychain_password: "your-keychain-password"
          keychain_path: "/path/to/keychain"
          app_id: "com.example.yourapp"
          provisioning_profile: "match_appstore_com.example.yourapp"

11. Fastlane Setup

Description

This action clones the Fastlane repository and configures Appfile and Matchfile.

Inputs

Input Name	Description	Required	Default
`git_url`	Git URL for the Fastlane repository	Yes	N/A
`app_identifier`	iOS App Identifier	Yes	N/A
`apple_id`	Apple ID	Yes	N/A
`itc_team_id`	ITC Team ID	Yes	N/A
`team_id`	Team ID	Yes	N/A
`certificates_git_url`	Git URL for the Fastlane repository containing certificates	Yes	N/A
`storage_mode`	Usually `git`	Yes	`git`
`certificate_type`	Can be `appstore`, `development`, etc.	Yes	`appstore`
`readonly`	Indicates if the certificates are readonly	Yes	`true`
`verbose`	Enable verbose output	Yes	`true`

Usage

jobs:
  setup-fastlane:
    runs-on: ubuntu-latest

    steps:
      - name: Setup Fastlane
        uses: mtdtechnology-net/github-actions/.github/actions/fastlane-setup@1.0.0
        with:
          git_url: "https://github.com/example/fastlane-repo.git"
          app_identifier: "com.example.app"
          apple_id: "your-apple-id@example.com"
          itc_team_id: "123456789"
          team_id: "987654321"
          certificates_git_url: "https://github.com/example/certificates.git"
          storage_mode: "git"
          certificate_type: "appstore"
          readonly: "true"
          verbose: "true"

12. Fastlane Sign

Description

This action runs prepare_signing in Fastlane to install the correct provisioning profile.

Inputs

Input Name	Description	Required	Default
`git_url`	Git URL of the repository containing certificates	Yes	N/A
`app_id`	iOS App Identifier	Yes	N/A

Usage

jobs:
  prepare-signing:
    runs-on: macos-latest

    steps:
      - name: Prepare Signing
        uses: mtdtechnology-net/github-actions/.github/actions/fastlane-sign@1.0.0
        with:
          git_url: "https://github.com/example/certificates.git"
          app_id: "com.example.app"

13. Fastlane TestFlight

Description

This action uses Fastlane to publish an iOS app to TestFlight with detailed release notes and contact information.

Inputs

Input Name	Description	Required	Default
`release_notes`	Publish release notes	Yes	N/A
`contact_email`	Contact email for TestFlight	Yes	N/A
`contact_first_name`	Contact first name for TestFlight	Yes	N/A
`contact_last_name`	Contact last name for TestFlight	Yes	N/A
`contact_phone`	Contact phone for TestFlight	Yes	N/A
`demo_account_name`	Demo account username for TestFlight	Yes	N/A
`demo_account_password`	Demo account password for TestFlight	Yes	N/A

Usage

jobs:
  publish-testflight:
    runs-on: macos-latest

    steps:
      - name: Publish to TestFlight
        uses: mtdtechnology-net/github-actions/.github/actions/fastlane-testflight@1.0.0
        with:
          release_notes: "This is a release note."
          contact_email: "contact@example.com"
          contact_first_name: "John"
          contact_last_name: "Doe"
          contact_phone: "+1234567890"
          demo_account_name: "testuser"
          demo_account_password: "password123"

14. Build Gradle for Android

Description

This action builds the Gradle project while excluding linting to save time and focus on the build process.

Usage

Below is an example workflow using the Build Gradle for Android action:

name: Build Gradle for Android

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  gradle-build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - name: Build Gradle
        uses: mtdtechnology-net/github-actions/.github/actions/build-gradle@1.0.0

15. Bump Build Version

Description

This action updates the versionCode and versionName in a Kotlin build.gradle.kts file.

Inputs

Input Name	Description	Required	Example
`gradle-path`	The path to the `build.gradle.kts`.	Yes	`app/build.gradle.kts`
`version-code`	The version code to set.	Yes	`42`
`version-name`	The version name to set.	Yes	`2.0.0`

Usage

Below is an example workflow using the Bump Build Version action:

name: Bump Build Version

on:
  pull_request:
    branches:
      - main

jobs:
  bump-version:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - name: Bump Build Version
        uses: mtdtechnology-net/github-actions/.github/actions/bump-version@1.0.0
        with:
          gradle-path: "app/build.gradle.kts"
          version-code: "42"
          version-name: "2.0.0"

16. Build Release

Description

This action builds a release target for Android projects, supporting environment variables for signing.

Inputs

Input Name	Description	Required	Example
`target`	Target that should be built.	Yes	`app`
`keystore-password`	Password for the keystore.	Yes	`password123`
`keystore-alias`	Alias for the keystore.	Yes	`myalias`
`key-password`	Password for the key inside the keystore.	Yes	`keypassword`

Usage

Below is an example workflow using the Build Release action:

name: Build Release

on:
  push:
    branches:
      - main

jobs:
  build-release:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - name: Build Release
        uses: mtdtechnology-net/github-actions/.github/actions/build-release@1.0.0
        with:
          target: "app"
          keystore-password: "password123"
          keystore-alias: "myalias"
          key-password: "keypassword"

17. UI Test for Android

Description

This action runs UI tests (instrumentation tests) for Android apps.

Usage

Below is an example workflow using the UI Test for Android action:

name: UI Test for Android

on:
  push:
    branches:
      - main

jobs:
  ui-tests:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - name: Run UI Tests
        uses: mtdtechnology-net/github-actions/.github/actions/ui-test@1.0.0

18. Unit Test for Android

Description

This action runs unit tests for Android apps using Gradle.

Usage

Below is an example workflow using the Unit Test for Android action:

name: Unit Test for Android

on:
  pull_request:
    branches:
      - main

jobs:
  unit-tests:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - name: Run Unit Tests
        uses: mtdtechnology-net/github-actions/.github/actions/unit-test@1.0.0

19. Upload `.zip` to GitHub Packages

Overview

This action uploads a .zip file to GitHub Packages.

Inputs

Name	Description	Required	Default
version	Version of your GitHub Package	true	0.0.1
path	Path to the specific `.zip` to publish	false	''

Steps

Builds the iOS project.
Uploads the specified .zip file to GitHub Packages using the gh CLI.

Usage Example

jobs:
  upload-zip:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3
      - name: Upload zip to GitHub Packages
        uses: ./path-to-action
        with:
          version: '1.0.0'
          path: './path/to/your/archive.zip'
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

20. Publish `.zip` to GitHub Packages

Overview

This action publishes a .zip file as an OCI artifact in GitHub Packages.

Inputs

Name	Description	Required
version	Version tag (e.g., v1.0.0)	true
name	Package name for the GitHub Package	true
path	Path to the `.zip` file to upload	true
repository	GitHub repository (e.g., user/repo)	true

Steps

Installs Docker Buildx to enable multi-platform builds.
Logs in to GitHub Container Registry.
Builds and pushes the .zip as an OCI artifact using Docker.

Usage Example

jobs:
  publish-zip:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Publish zip to GitHub Packages
        uses: ./path-to-action
        with:
          version: 'v1.0.0'
          name: 'my-package'
          path: './path/to/your/archive.zip'
          repository: 'user/repo'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

21. Create `.xcramework`

Overview

This action builds an XCFramework and saves it as a .zip file for iOS distribution.

Inputs

Name	Description	Required
scheme	Scheme to be built for distribution	false
framework_name	Specify the input & output framework name	false
path	Path to the Swift Package or Xcode project	true

Steps

Build the iOS project using xcodebuild for the iOS platform.
Build the iOS Simulator version using xcodebuild.
Create an XCFramework by merging the iOS and iOS Simulator builds.
Zip the XCFramework for distribution.

Usage Example

jobs:
  create-xcframework:
    runs-on: macos-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Create XCFramework
        uses: ./path-to-action
        with:
          scheme: 'MyAppScheme'
          framework_name: 'MyFramework'
          path: './path/to/xcode/project'

Getting Started

Clone this repository into your project.
Reference the actions in your workflows using the examples provided above.
Customize the inputs as needed for your specific project requirements.

Contributing

Feel free to submit issues or pull requests to improve these actions. Contributions are always welcome!

License

This repository is licensed under the MIT License.

Name		Name	Last commit message	Last commit date
Latest commit History 31 Commits
.github		.github
CHANGELOG.md		CHANGELOG.md
LICENSE.md		LICENSE.md
README.md		README.md

Uh oh!

Folders and files

Latest commit

History

Repository files navigation

GitHub Actions

Actions in this Repository

1. Code Quality with Ktlint

Description

Inputs

Usage

2. Xcode Test Runner

Description

Inputs

Usage

3. Xcodebuild SPM Test Action

Inputs

Outputs

Usage

4. Code Quality with SwiftLint

Description

Inputs

Usage

Example Arguments

SwiftLint Configuration

Benefits

Example Workflow for Changed Files Only

How It Works

5. Cleanup Workspace

Description

Inputs

Usage

Benefits

How It Works

6. Slack Notification

Description

Inputs

Usage

Benefits

How It Works

7. Xcov

Description

Inputs

Usage

8. API Key

Description

Usage

9. Fastlane Build Number

Description

Inputs

Usage

10. Fastlane Build Release

Description

Inputs

Usage

11. Fastlane Setup

Description

Inputs

Usage

12. Fastlane Sign

Description

Inputs

Usage

13. Fastlane TestFlight

Description

Inputs

Usage

14. Build Gradle for Android

Description

Usage

15. Bump Build Version

Description

Inputs

Usage

16. Build Release

Description

Inputs

Usage

17. UI Test for Android

Description

19. Upload `.zip` to GitHub Packages

20. Publish `.zip` to GitHub Packages

21. Create `.xcramework`