Add CI and DocC Makefile workflows #148
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| name: CI | ||
|
|
||
| on: | ||
| pull_request: | ||
| push: | ||
| branches: | ||
| - main | ||
|
|
||
| concurrency: | ||
| group: ci-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| build-test-lint: | ||
| runs-on: macos-26 | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Select latest stable Xcode | ||
| uses: maxim-lobanov/setup-xcode@v1 | ||
| with: | ||
| xcode-version: latest-stable | ||
|
|
||
| - name: Install tools | ||
| run: brew install swiftlint swiftformat | ||
|
|
||
| - name: Build | ||
| run: make build RAW_XCODEBUILD=1 | ||
|
|
||
| - name: Test | ||
| env: | ||
| XCORE_CI: "true" | ||
| SIMCTL_CHILD_XCORE_CI: "true" | ||
| run: make test XCORE_CI=1 | ||
|
|
||
| - name: Lint | ||
| run: make lint |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,71 +1,70 @@ | ||
| name: Documentation | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| branches: | ||
| - main | ||
| release: | ||
| types: [published] | ||
|
|
||
| concurrency: | ||
| group: docs-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| permissions: | ||
| contents: write | ||
|
|
||
| jobs: | ||
| build-and-deploy: | ||
| runs-on: macos-26 | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Select latest stable Xcode | ||
| uses: maxim-lobanov/setup-xcode@v1 | ||
| with: | ||
| xcode-version: latest-stable | ||
|
|
||
| - name: Resolve documentation version | ||
| id: docs | ||
| run: | | ||
| if [[ "${{ github.event_name }}" == "release" ]]; then | ||
| version="${{ github.event.release.tag_name }}" | ||
| else | ||
| version="main" | ||
| fi | ||
|
|
||
| echo "version=$version" >> "$GITHUB_OUTPUT" | ||
| echo "base_path=xcore/$version" >> "$GITHUB_OUTPUT" | ||
|
|
||
| - name: Build DocC static site | ||
| run: | | ||
| make build-docc \ | ||
| DOCC_OUTPUT_PATH="$PWD/.build/docc-site" \ | ||
| DOCC_HOSTING_BASE_PATH="${{ steps.docs.outputs.base_path }}" | ||
|
|
||
| - name: Add redirect | ||
| run: | | ||
| cat > "$PWD/.build/docc-site/index.html" <<'HTML' | ||
| <!doctype html> | ||
| <html> | ||
| <head> | ||
| <meta http-equiv="refresh" content="0; url=documentation/xcore/"> | ||
| </head> | ||
| <body> | ||
| <a href="documentation/xcore/">Xcore documentation</a> | ||
| </body> | ||
| </html> | ||
| HTML | ||
|
|
||
| - name: Deploy to gh-pages | ||
| uses: JamesIves/github-pages-deploy-action@v4 | ||
| with: | ||
| branch: gh-pages | ||
| folder: .build/docc-site | ||
| target-folder: ${{ steps.docs.outputs.version }} | ||
| clean: false | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,7 @@ xcuserdata | |
| DerivedData | ||
| *.hmap | ||
| *.ipa | ||
| *.doccarchive | ||
| *.xcuserstate | ||
| .DS_Store | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| --swiftversion 6.3 | ||
|
|
||
| # File Options | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ SHELL := /bin/bash | |
| .DEFAULT_GOAL := help | ||
| .NOTPARALLEL: | ||
|
|
||
| XCODE_APP ?= $(if $(MD_APPLE_SDK_ROOT),$(MD_APPLE_SDK_ROOT),/Applications/Xcode.app) | ||
| DEVELOPER_DIR ?= $(XCODE_APP)/Contents/Developer | ||
| export DEVELOPER_DIR | ||
| export PATH := $(DEVELOPER_DIR)/usr/bin:$(DEVELOPER_DIR)/Platforms/iPhoneSimulator.platform/Developer/usr/bin:$(PATH) | ||
|
|
@@ -12,6 +12,9 @@ SCHEME := Example | |
| CONFIGURATION ?= Debug | ||
| DERIVED_DATA_PATH ?= $(CURDIR)/.build/DerivedData | ||
| APP_BUNDLE_ID ?= com.xcore.example | ||
| DOCC_TARGET ?= Xcore | ||
|
Owner
Author
There was a problem hiding this comment. @cursoragent why does this need to be a var??? |
||
| DOCC_OUTPUT_PATH ?= $(CURDIR)/.build/docc | ||
| DOCC_HOSTING_BASE_PATH ?= xcore | ||
|
|
||
|
|
||
| SIMULATOR_NAME ?= iPhone 17 Pro | ||
| SIMULATOR_OS ?= latest | ||
|
|
@@ -20,12 +23,21 @@ BUILD_DESTINATION ?= generic/platform=iOS Simulator | |
| TEST_ONLY ?= | ||
|
|
||
| XCODEBUILD := xcodebuild | ||
| XCODEBUILD_FLAGS ?= -skipPackagePluginValidation -skipMacroValidation | ||
|
Owner
Author
There was a problem hiding this comment. @cursoragent shouldnt most of this be consolidated under CI flags so we can just simply do this in this file and not have logic in the workflow and the make file. |
||
| XCODEBUILD_BUILD_SETTINGS ?= | ||
| RAW_XCODEBUILD ?= | ||
| APP_PATH := $(DERIVED_DATA_PATH)/Build/Products/$(CONFIGURATION)-iphonesimulator/Example.app | ||
| XCODEBUILD_OUTPUT_FILTER := perl -ne 'next if /\[MT\] IDERunDestination: Supported platforms for the buildables in the current scheme is empty\.|\[MT\] IDETestOperationsObserverDebug:/; s/ on '\''[^'\'']+'\''// if /^(Test suite|Test case) /; print;' | ||
|
|
||
| ifeq ($(XCORE_CI),1) | ||
| XCODEBUILD_BUILD_SETTINGS += OTHER_SWIFT_FLAGS="\$$(inherited) -DXCORE_CI" | ||
| endif | ||
|
|
||
| define xcodebuild_run | ||
| @set -o pipefail; \ | ||
| if [ -n "$(RAW_XCODEBUILD)" ]; then \ | ||
| $(1); \ | ||
| elif command -v xcpretty >/dev/null 2>&1; then \ | ||
| $(1) 2>&1 | $(XCODEBUILD_OUTPUT_FILTER) | xcpretty; \ | ||
| elif command -v xcbeautify >/dev/null 2>&1; then \ | ||
| $(1) 2>&1 | $(XCODEBUILD_OUTPUT_FILTER) | xcbeautify; \ | ||
|
|
@@ -40,7 +52,7 @@ TEST_ONLY_ARG := -only-testing:$(TEST_ONLY) | |
| endif | ||
| endif | ||
|
|
||
| .PHONY: help _ensure_xcode clean build build-docc tests test run lint format format-check | ||
|
|
||
| _ensure_xcode: | ||
| @test -d "$(DEVELOPER_DIR)" || (echo "Xcode not found at $(DEVELOPER_DIR)" && exit 1) | ||
|
|
@@ -57,17 +69,28 @@ clean: ## Remove local build and package state used by Make targets | |
| @rm -rf "$(DERIVED_DATA_PATH)" "$(CURDIR)/.build/workspace-state.json" | ||
|
|
||
| build: _ensure_xcode ## Build the example app and its framework dependencies | ||
| $(call xcodebuild_run,$(XCODEBUILD) build $(XCODEBUILD_FLAGS) -workspace "$(WORKSPACE)" -scheme "$(SCHEME)" -configuration "$(CONFIGURATION)" -derivedDataPath "$(DERIVED_DATA_PATH)" -destination "$(BUILD_DESTINATION)" $(XCODEBUILD_BUILD_SETTINGS)) | ||
|
|
||
| build-docc: _ensure_xcode ## Generate DocC static site output under DOCC_OUTPUT_PATH | ||
| @rm -rf "$(DOCC_OUTPUT_PATH)" | ||
| @swift package \ | ||
| --allow-writing-to-directory "$(DOCC_OUTPUT_PATH)" \ | ||
| generate-documentation \ | ||
| --target "$(DOCC_TARGET)" \ | ||
| --disable-indexing \ | ||
| --output-path "$(DOCC_OUTPUT_PATH)" \ | ||
| --transform-for-static-hosting \ | ||
| --hosting-base-path "$(DOCC_HOSTING_BASE_PATH)" | ||
|
|
||
| test: _ensure_xcode ## Run tests through the Example scheme | ||
| @set -o pipefail; \ | ||
| $(XCODEBUILD) test -quiet $(XCODEBUILD_FLAGS) -workspace "$(WORKSPACE)" -scheme "$(SCHEME)" -configuration "$(CONFIGURATION)" -derivedDataPath "$(DERIVED_DATA_PATH)" -destination "$(SIMULATOR_DESTINATION)" $(TEST_ONLY_ARG) $(XCODEBUILD_BUILD_SETTINGS) 2>&1 | $(XCODEBUILD_OUTPUT_FILTER) && \ | ||
| echo "Tests passed" | ||
|
|
||
| run: _ensure_xcode ## Build, install, and launch the app in the configured simulator | ||
| @xcrun simctl boot "$(SIMULATOR_NAME)" >/dev/null 2>&1 || true | ||
| @xcrun simctl bootstatus "$(SIMULATOR_NAME)" -b | ||
| $(call xcodebuild_run,$(XCODEBUILD) build $(XCODEBUILD_FLAGS) -workspace "$(WORKSPACE)" -scheme "$(SCHEME)" -configuration "$(CONFIGURATION)" -derivedDataPath "$(DERIVED_DATA_PATH)" -destination "$(SIMULATOR_DESTINATION)" $(XCODEBUILD_BUILD_SETTINGS)) | ||
| @test -d "$(APP_PATH)" || (echo "Built app not found at $(APP_PATH)" && exit 1) | ||
| @open -a Simulator >/dev/null 2>&1 || true | ||
| @xcrun simctl install booted "$(APP_PATH)" | ||
|
|
@@ -76,5 +99,8 @@ run: _ensure_xcode ## Build, install, and launch the app in the configured simul | |
| format: ## Run SwiftFormat | ||
| @swiftformat . | ||
|
|
||
| format-check: ## Check SwiftFormat without changing files | ||
| @swiftformat --lint . | ||
|
|
||
| lint: ## Run SwiftLint | ||
| @swiftlint lint | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| // | ||
| // Xcore | ||
| // Copyright © 2026 Xcore | ||
| // MIT license, see LICENSE file for details | ||
| // | ||
|
|
||
| import Foundation | ||
|
|
||
| enum TestEnvironment { | ||
| static var isCI: Bool { | ||
| #if XCORE_CI | ||
|
Owner
Author
There was a problem hiding this comment. @cursoragent why not just use CI flags instead of prefixing XcoreCI? CI means CI. |
||
| true | ||
| #else | ||
| let environment = ProcessInfo.processInfo.environment | ||
| return environment["CI"] == "true" || environment["XCORE_CI"] == "true" | ||
| #endif | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cursoragent remove this change as it's fairly massive change on each push to main. Doc build should be manual trigger.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed the automatic DocC build on push to
main. The Documentation workflow now runs only on:workflow_dispatch)The
push: branches: [main]trigger is gone from.github/workflows/documentation.yml, so docs are no longer rebuilt and redeployed on every push tomain. The PR description was updated to match.