ci: add GitHub Actions workflow to build the demo app and test the iOS library (#259)

Signed-off-by: Pierre-Yves Lapersonne <[email protected]>

Author: pylapp

.github/DEVELOP.md

@@ -279,9 +279,23 @@ Do not forget if possible to enable the warnings in the end of the file to reduc
 
 ## CI/CD
 
-We use GitLab CI for CI/CD with our own runners so as to keep private our sensitive files likes certificates and provisioning profiles.
+### GitHub Action
+
+We use also *GitHub Actions* so as to define a workflow with some actions to build demo application and test the library.
+It will help use to ensure code on pull requests or being merged compiles and has all tests green.
+This workflow is defined in [this YAML](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/build-and-test.yml)
+
+We have also a *gitleaks* workflow making some scans on the code to loook fo secrets leaks, defined in [this YAML](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/gitleaks-action.yml).
+
+We use also two GitHub apps making controls on pull requests and defining wether or not prerequisites are filled or not.
+There is on control to check if [PR template are all defined ](https://github.com/stilliard/github-task-list-completed), and one if [DCO is applied](https://probot.github.io/apps/dco/).
+
+### GitLab CI (internal)
+
+We use *GitLab CI*for CI/CD with our own runners so as to keep private our sensitive files likes certificates and provisioning profiles.
 Our currant plan does not allow to make GitHub mirroring, so we use GitHub HTTP REST API to download sources, before using Xcode to build and sign.
-If you want to set up your runners, feel free to have a look on */docs_release/README.md*
-However of course you will have to define all the variables, secrets and have the mandatory files listed above.
+However of course you will have to define all the variables, secrets and have the mandatory files.
+
+You can find more details about the pipelines, how to set up runners and scripts to use [in the wiki](https://github.com/Orange-OpenSource/ouds-ios/wiki/5-%E2%80%90-About-continuous-integration-and-delivery).
 
-You can find more details about the pipelines and script [in the wiki](https://github.com/Orange-OpenSource/ouds-ios/wiki/5-%E2%80%90-About-continuous-integration-and-delivery).
+In few words, there is a pipeline containing some stages and jobs to build alpha, nightly/beta and production releases.

.github/workflows/build-and-test.yml

@@ -0,0 +1,82 @@
+#
+# Software Name: Orange Unified Design System
+# SPDX-FileCopyrightText: Copyright (c) Orange SA
+# SPDX-License-Identifier: MIT
+#
+# This software is distributed under the MIT license,
+# the text of which is available at https://opensource.org/license/MIT/
+# or see the "LICENSE" file for more details.
+#
+# Authors: See CONTRIBUTORS.txt
+# Software description: A SwiftUI components library with code examples for Orange Unified Design System
+#
+
+name: Build and Test
+
+on:
+  # For protected and most important branches
+  push:
+    branches:
+      - main
+      - develop
+
+  # To trigger manually
+  workflow_dispatch:
+
+  # Pull request events
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+jobs:
+  # Build the app (if there are linter errors or compiler issues, it will fail)
+  build:
+    runs-on: macos-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Xcode 16
+        run: |
+          sudo xcode-select -s /Applications/Xcode_16.app/Contents/Developer
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+
+      - name: Install Fastlane
+        run: |
+          bundle install
+
+      - name: Build demo app
+        run: |
+          cd Showcase
+          bundle exec fastlane buildDebugApp
+
+  # Test the library with unit tests
+  test:
+    runs-on: macos-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Xcode 16
+        run: |
+          sudo xcode-select -s /Applications/Xcode_16.app/Contents/Developer
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+
+      - name: Install Fastlane
+        run: |
+          bundle install
+
+      - name: Run unit tests on demo app
+        run: |
+          cd Showcase
+          bundle exec pod install
+          bundle exec fastlane ios test

.gitignore

@@ -27,6 +27,9 @@
 /Showcase/Showcase.xcworkspace/xcuserdata/
 /DerivedData/
 
+# Produced by Fastlane
+/Showcase/build/
+
 # Produced by Swift Package Manager
 /.swiftpm/xcode/xcshareddata/
 /.swiftpm/xcode/xcuserdata/

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- [Tool] GitHub Actions workflow for CI/CD ([#256](https://github.com/Orange-OpenSource/ouds-ios/issues/256))
 - [DemoApp] Add new tokens in size tokens page ([#245](https://github.com/Orange-OpenSource/ouds-ios/issues/245))
 - [Library] Semantic token `borderWidthFocusInset` (value of `borderWidth100`) ([#207](https://github.com/Orange-OpenSource/ouds-ios/issues/207), [#241](https://github.com/Orange-OpenSource/ouds-ios/issues/241))
 - [Library] Semantic token `fontWeightCode` ([#242](https://github.com/Orange-OpenSource/ouds-ios/issues/242))

Showcase/fastlane/Fastfile

@@ -100,10 +100,17 @@ platform :ios do
                 device: device,
                 skip_build: true)
 
-            publish_mattermost_notification("🧪 ✅ No issue with tests")
-
+            if MATTERMOST_HOOK_URL.nil? || MATTERMOST_HOOK_URL.empty?
+                puts "ℹ️ No MATTERMOST_HOOK_URL defined, it could mean this lane is called on GitHub Action workflow or locally"
+            else
+                publish_mattermost_notification("🧪 ✅ No issue with tests")
+            end
         rescue => error
-            publish_mattermost_notification("🧪 🚨 @channel Some issue occured with tests (:test)")
+            if MATTERMOST_HOOK_URL.nil? || MATTERMOST_HOOK_URL.empty?
+                puts "ℹ️ No MATTERMOST_HOOK_URL defined, it could mean this lane is called on GitHub Action workflow or locally"
+            else
+                publish_mattermost_notification("🧪 🚨 @channel Some issue occured with tests (:test)")
+            end
             raise error
         end
     end
@@ -125,10 +132,17 @@ platform :ios do
                 skip_build: true
             )
 
-            publish_mattermost_notification("🧪 ✅ No issue with UI tests")
-
+            if MATTERMOST_HOOK_URL.nil? || MATTERMOST_HOOK_URL.empty?
+                puts "ℹ️ No MATTERMOST_HOOK_URL defined, it could mean this lane is called on GitHub Action workflow or locally"
+            else
+                publish_mattermost_notification("🧪 ✅ No issue with UI tests")
+            end
         rescue => error
-            publish_mattermost_notification("🧪 🚨 @channel Some issue occured with tests (:test_ui)")
+            if MATTERMOST_HOOK_URL.nil? || MATTERMOST_HOOK_URL.empty?
+                puts "ℹ️ No MATTERMOST_HOOK_URL defined, it could mean this lane is called on GitHub Action workflow or locally"
+            else
+                publish_mattermost_notification("🧪 🚨 @channel Some issue occured with tests (:test_ui)")
+            end
             raise error
         end
     end
@@ -167,10 +181,11 @@ platform :ios do
             scheme: OUDS_SCHEME,
             output_directory: 'build/',
             archive_path: 'build/',
-            output_name: 'oudsApp',
+            output_name: 'odsApp',
             configuration: 'Debug',
             include_symbols: true,
-            export_method: 'development'
+            skip_archive: true,
+            destination: "generic/platform=iOS Simulator"
         )
     end