iOS CircleCI to GitHub Actions reusable workflow conversion #67

timkimadobe · 2024-08-08T22:11:27Z

Questions for reviewers

For the standardized build and test workflow:

Are the current make rule names desired as the standard?

Important

I couldn't figure out how to get custom derived data paths working with the Codecov action, so Makefiles must remove the -resultBundlePath flag when using xcodebuild test. Ex: -resultBundlePath build/reports/iosFunctionalResults.xcresult. Is this acceptable?

Based on the Codecov action documentation, there doesn't seem to be a way to override the Xcode plugin's default search directory of DerivedData folder: /Users/runner/Library/Developer/Xcode/DerivedData: https://github.com/codecov/codecov-action?tab=readme-ov-file#arguments
An alternative is we could download/install the Codecov CLI manually (handling things like caching etc), but the issue with this approach is that each test group (ex: iOS unit, tvOS functional, etc) would all need their own individual input: options for passing their specific flags to the CLI (this input explosion would be the same if we passed options to the Codecov Action as well): https://docs.codecov.com/docs/the-codecov-cli

Description

Note

See #64 for additional context on reusable workflows

This PR:

Converts CircleCI PR check workflow into GitHub Action workflow format AND
Is defined as a reusable workflow so that other repos are able to take advantage of the common flow, and are able to trigger on whatever criteria they need (the intended use is on PR creation)
Enables Codecov reporting on all test jobs

The goal is to reduce the amount of workflow maintenance work that needs to be done across repos (ex: action version upgrades, runner changes, iOS simulator updates, etc).

There are three new files:

`ios-build-and-test.yml`

Build and test (CircleCI converted to GitHub actions reusable workflow) - which has the standard PR check make commands

Uses new composite action which handles setup caching logic to reduce boilerplate: .github/actions/ios-setup-dependencies-action/action.yml
Adds job run flags so that callers can control which checks are run for their repo (each are optional, and default to false)
Allows for matrix of devices and OS for testing
- Uses defaults if matrix values are not provided by the caller

`ios-custom-command-build-and-test.yml`

This is a modularized workflow that handles:

Matrix logic - checking if matrix values were passed in or not, and providing default values
Caching logic
Running the make command and passing in the following new variables for use in the context of the make rule:
- IOS_DEVICE_NAME="${{ matrix.ios-device }}" IOS_VERSION="${{ matrix.ios }}" TVOS_DEVICE_NAME="${{ matrix.tvos-device }}" TVOS_VERSION="${{ matrix.tvos }}"

Note

This modular workflow is used by ios-build-and-test.yml to avoid repeating a lot of the same setup code, and it can also be called by repos directly if they need to use non-standard make commands.

`ios-validate-code.yml`

Validates the code by using the command make lint

Example caller repo usage:

name: Build and Test

on:
  pull_request:

jobs:
  build-and-test:
    name: " "
    uses: adobe/aepsdk-commons/.github/workflows/[email protected]
    with:
      ios-device-names: '["iPhone 15", "iPhone 15 Pro"]'
      ios-versions: '["18.0"]'
      tvos-device-names: '["Apple TV"]'
      tvos-versions: '["18.0", "18.1"]'
      run-test-ios-unit: true
      run-test-ios-functional: false
      run-test-ios-integration: false
      run-test-tvos-unit: true
      run-test-tvos-functional: false
      run-build-xcframework-and-app: false

Example runs

Example run (with matrix using both iOS and tvOS paths): https://github.com/timkimadobe/aepsdk-edge-ios/actions/runs/11695962501

How the PR checks look: trigger change timkimadobe/aepsdk-edge-ios#45

Example run with Codecov enabled: https://github.com/timkimadobe/aepsdk-edge-ios/actions/runs/11714920884/job/32630451484

Codecov results: https://app.codecov.io/github/timkimadobe/aepsdk-edge-ios/commit/ead31d050d1b02c888b983c2f1d7670efb98910f/indirect-changes
PR with codecov bot comment: trigger change timkimadobe/aepsdk-edge-ios#47

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have signed the Adobe Open Source CLA.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

praveek · 2024-08-19T19:53:24Z

.github/actions/setup-action/action.yml

@@ -0,0 +1,48 @@
+name: "Setup Dependencies"


The setup-action is iOS specific. Can you rename it accordingly?

Yes, updated!

praveek · 2024-08-19T19:56:14Z

.github/actions/setup-action/action.yml

+      with:
+        path: |
+          Pods
+          SampleApps/TestApp/Pods


The path changes for each repo. Can we exclude it from the cache for now and consider including it later if it becomes a concern?

Yes, removed

praveek · 2024-08-19T19:59:33Z

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

+        uses: actions/[email protected]
+        with:
+          repository: adobe/aepsdk-commons
+          ref: main


This should not default to main.

praveek · 2024-08-19T20:10:13Z

Thanks for the PR. I have a few more suggestions

Include a README that explains how an extension can adopt these reusable workflows. It should specify which make commands are required, any assumptions about folder structure, and file names.
Consider adding default values for device_name and os_version.
Since only a few extensions support tvOS, add a flag for this. The tvos tests should also check for this flag along with run_test_tvos_* flags.
Extend the testing script to support a matrix of device OS versions.

praveek · 2024-08-19T20:15:41Z

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

+  test-ios-integration:
+    runs-on: macos-latest
+    needs: validate-code
+    if: inputs.run_test_ios_integration && (inputs.github_ref == 'refs/heads/main' || inputs.github_ref == 'refs/heads/staging')


Adding these checks && (inputs.github_ref == 'refs/heads/main' || inputs.github_ref == 'refs/heads/staging') makes it impossible to override the default behavior. Can we instead rely solely on a boolean value and move these checks to the caller repo?

Similar comment for build_xcframework_and_app

Update cache action to latest 4.1.2 Update save cache actions to explicitly use the save action Update titles to sentence case

Add caching logic Add workflow_tag input variable

Update all inputs to use hyphen for consistency Remove github ref input and use the value auto populated in the env since it is the same value

…rol this behavior

…sed on cache hit result

…ry values also add descriptions of usage and formatting Update test step run to false for all cases Apply matrix strategy for all test steps Use branch ref instead of tag for testing Test using the custom command instead of rewritten job steps

…validation step

Test different yaml path using current working directory

Apply codecov flag and secrets passing to all test jobs

Remove codecov yaml path

timkimadobe

Thanks for the review @praveek! Updated based on feedback - please let me know what you think

timkimadobe · 2024-10-30T02:03:16Z

.github/actions/setup-action/action.yml

@@ -0,0 +1,48 @@
+name: "Setup Dependencies"


Yes, updated!

timkimadobe · 2024-10-30T02:03:39Z

.github/actions/setup-action/action.yml

+      with:
+        path: |
+          Pods
+          SampleApps/TestApp/Pods


Yes, removed

timkimadobe · 2024-11-07T01:47:28Z

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

+    with:
+      ios-device-names: ${{ inputs.ios-device-names }}
+      ios-versions: ${{ inputs.ios-versions }}
+      command: make unit-test-ios


Yes, added Codecov support for each test case with some caveats - please see the main PR description under Questions for reviewers section for more details. Also added an example of the Codecov enabled run under Example runs section

timkimadobe · 2024-11-07T01:49:00Z

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

+jobs:
+  validate-code:
+    name: Validate Code
+    uses: timkimadobe/aepsdk-commons/.github/workflows/ios-validate-code.yml@ios-circleci-to-github


Updated! Using the major version aligned tag: gha-ios-5.0.0

praveek · 2024-11-12T18:55:32Z

@timkimadobe Regarding Codecov, I noticed there is a directory argument that allows specifying custom directories. Additionally, I saw an issue where Codecov v4 does not support .xcresult-based tests. If this is the case, could you try reverting to v3 to see if it works for our use case?

praveek · 2024-11-12T22:23:13Z

Everything else looks good. However, the workflows contain several internal references using specific tags. Can you also create a script and release action for this repo that will find all references like the one below and replace them with the tag we are creating?

uses: adobe/aepsdk-commons/.github/actions/[email protected]

timkimadobe · 2024-11-13T21:26:47Z

@timkimadobe Regarding Codecov, I noticed there is a directory argument that allows specifying custom directories. Additionally, I saw an issue where Codecov v4 does not support .xcresult-based tests. If this is the case, could you try reverting to v3 to see if it works for our use case?

Based on a test run, the v4 Codecov action looks like it does support code coverage for tests not by using the .xcresult file, but by using the Codecov CLI Xcode plugin they have which:

Looks for .profdata (profile data files generated by LLVM’s coverage instrumentation)
Looks for .xctest bundles (the compiled test executables)
Runs xcrun llvm-cov show -instr-profile <path_to_profdata> <path_to_executable> which outputs in a Codecov supported format

But it also looks like while it does support coverage in this way out of the box, this plugin doesn't currently support overriding the default derived data directory (so I don't think using the directory input for the overall action will work in this case: https://github.com/codecov/codecov-cli/blob/a89f1080e194a8c93c1e7e9b904fa13080d287ad/codecov_cli/plugins/__init__.py#L84

Given this I was thinking the most convenient usage would be to simply align with the default DerivedData directory used by the Xcode plugin, and if we need the .xcresult in other CI steps (ex: upload artifacts, etc), we can copy it to the desired directory?

For reference, here is an example run using the default DerivedData directory with successfully uploaded coverage: https://github.com/timkimadobe/aepsdk-edge-ios/actions/runs/11714920884/job/32630451484

Codecov results: https://app.codecov.io/github/timkimadobe/aepsdk-edge-ios/commit/ead31d050d1b02c888b983c2f1d7670efb98910f/indirect-changes
PR with codecov bot comment: trigger change timkimadobe/aepsdk-edge-ios#47

timkimadobe · 2024-11-13T21:33:56Z

Everything else looks good. However, the workflows contain several internal references using specific tags. Can you also create a script and release action for this repo that will find all references like the one below and replace them with the tag we are creating?
uses: adobe/aepsdk-commons/.github/actions/[email protected]

Yes, I think that sounds good - I've created a separate PR for these changes:

Overhaul versions.py to handle generic named versions #100

timkimadobe added 5 commits August 7, 2024 17:37

Create composable action that helps set up iOS dependencies

c4d1179

Create reusable workflow for iOS build and test checks for PR validation

04c8d2a

Add flags for jobs to run

f8613b5

Create custom command build and test workflow

c6e3794

Update repo and branch to adobe main

519064c

timkimadobe requested review from emdobrin, praveek, prudrabhat and sbenedicadb August 8, 2024 22:11

timkimadobe mentioned this pull request Aug 8, 2024

iOS reusable workflows: release and update versions #64

Merged

10 tasks

timkimadobe changed the title ~~CircleCI to GitHub Actions reusable workflow conversion~~ iOS CircleCI to GitHub Actions reusable workflow conversion Aug 9, 2024

praveek reviewed Aug 19, 2024

View reviewed changes

timkimadobe added 14 commits October 29, 2024 19:10

Rename directory and workflow to be platform specific

e66e41d

Update cache action to latest 4.1.2 Update save cache actions to explicitly use the save action Update titles to sentence case

Update title

213073a

Update action versions to latest

61169a4

Add caching logic Add workflow_tag input variable

Testing calling remote action directly

23a5079

TEST: using remote composite action

4cea9e8

Remove outdated input workflow_tag

3e673cd

Update all steps to use remote dependency setup composite action

ae10e89

Update all inputs to use hyphen for consistency Remove github ref input and use the value auto populated in the env since it is the same value

Remove branch conditionals on job steps to allow caller repos to cont…

402a665

…rol this behavior

TEST: add support for matrix device and os

97181e6

Update iOS dependencies action to better handle explicit save step ba…

1ec45a7

…sed on cache hit result

Add quotes to handle spaces in device names

6c46355

Fix missing if checks for job steps to run

54b8614

Update custom command workflow to use composable action and optional …

b65cefc

…validation step

timkimadobe added 15 commits November 6, 2024 14:51

Try passing secrets using inherit

9844fd1

Try specifying yaml path

8826545

Add verbose output for debugging

c4e9710

Test passing directory

7ab55fa

disable test run - only codecov

f475618

Fix pass through directory

1276c6d

Reduce matrix runner parallelism to 1

d8df135

Test different yaml path using current working directory

Test wildcard xcresult

3a4cff3

try moving to dervieddata folder

c5c5c77

test different directory

6da50be

test ls

f374766

update to run test

e94e87f

Remove codecov directory input

549a8c5

Apply codecov flag and secrets passing to all test jobs

Create toggle for enabling codecov with default to true

f49410f

Remove codecov yaml path

Apply production configuration values

00c7d83

timkimadobe commented Nov 7, 2024

View reviewed changes

timkimadobe requested a review from praveek November 7, 2024 23:11

timkimadobe added 4 commits November 8, 2024 15:15

Merge branch 'main' into ios-circleci-to-github

759b74c

Update workflow README with iOS build and test workflow requirements

58fee35

Update build and test Makefile docs for matrix compatibility

7eb0a4d

Update iOS release workflow README

2dcd4b8

praveek approved these changes Nov 14, 2024

View reviewed changes

timkimadobe merged commit 5202e48 into adobe:main Nov 15, 2024
2 checks passed

This was referenced Nov 15, 2024

Migrate build and test workflow to GitHub Actions adobe/aepsdk-edge-ios#509

Merged

Android CircleCI to GitHub Actions reusable workflow conversion #101

Merged

timkimadobe deleted the ios-circleci-to-github branch December 4, 2024 23:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

iOS CircleCI to GitHub Actions reusable workflow conversion #67

iOS CircleCI to GitHub Actions reusable workflow conversion #67

timkimadobe commented Aug 8, 2024 •

edited

Loading

praveek Aug 19, 2024

timkimadobe Oct 30, 2024

praveek Aug 19, 2024 •

edited

Loading

timkimadobe Oct 30, 2024

praveek Aug 19, 2024

praveek commented Aug 19, 2024 •

edited

Loading

praveek Aug 19, 2024

praveek Aug 19, 2024

timkimadobe left a comment

timkimadobe Oct 30, 2024

timkimadobe Oct 30, 2024

timkimadobe Nov 7, 2024

timkimadobe Nov 7, 2024

praveek commented Nov 12, 2024

praveek commented Nov 12, 2024

timkimadobe commented Nov 13, 2024 •

edited

Loading

timkimadobe commented Nov 13, 2024 •

edited

Loading

iOS CircleCI to GitHub Actions reusable workflow conversion #67

iOS CircleCI to GitHub Actions reusable workflow conversion #67

Conversation

timkimadobe commented Aug 8, 2024 • edited Loading

Questions for reviewers

Description

ios-build-and-test.yml

ios-custom-command-build-and-test.yml

ios-validate-code.yml

Example runs

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

praveek Aug 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

praveek commented Aug 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timkimadobe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

praveek commented Nov 12, 2024

praveek commented Nov 12, 2024

timkimadobe commented Nov 13, 2024 • edited Loading

timkimadobe commented Nov 13, 2024 • edited Loading

timkimadobe commented Aug 8, 2024 •

edited

Loading

`ios-build-and-test.yml`

`ios-custom-command-build-and-test.yml`

`ios-validate-code.yml`

praveek Aug 19, 2024 •

edited

Loading

praveek commented Aug 19, 2024 •

edited

Loading

timkimadobe commented Nov 13, 2024 •

edited

Loading

timkimadobe commented Nov 13, 2024 •

edited

Loading