Update iOS release reusable workflow - handle multi-extension repos #81

timkimadobe · 2024-10-23T02:05:09Z

Description

This PR updates the iOS release reusable workflow to be able to handle multi-extension repos with the main changes being:

Ability to specify:
- A list of extensions to release (ex: "AEPServices, AEPCore")
- A list of extension dependencies to release, which are not contained in the repo itself (ex: "AEPRulesEngine")
- A list of extensions to publish to CocoaPods (ex: "AEPServices, AEPCore")

When not specifying any repos in the extensions to release, the script will still:

Run make check-version
Optionally publish pods, if that arg has been provided with valid values

Example job runs

Core iOS (multi-extension): https://github.com/timkimadobe/aepsdk-core-ios/actions/runs/11471135041/job/31921556669

NOTE: Job failure is due to missing CocoaPods secret token when running in fork (also don't want to publish as a test anyways)
Resulting GitHub release: https://github.com/timkimadobe/aepsdk-core-ios/releases/tag/5.3.1
- Note the assets that are also included match what was specified in the job, with the proper names
- NOTE: the auto-generated description for the release is empty, even though the workflow is configured to create this, and this is because it relies on PR descriptions but those are in the main repo, not in the fork.

Usage examples

Single extension repos can also use this workflow without too much friction:

name: Release

on:
  workflow_dispatch:
    inputs:
      tag:
        description: 'The tag (version) to be released (ex: 1.2.3).'
        type: string
        required: true
        default: ''

      create-github-release:
        description: 'Create a GitHub release with uploaded artifacts. If the provided `tag` does not exist, it will be created.'
        type: boolean
        required: true
        default: true

      pod-publish-extensions:
        description: 'Publish AEPEdge to Cocoapods.'
        type: boolean
        required: true
        default: true

jobs:
  release:
    uses: adobe/aepsdk-commons/.github/workflows/ios-release.yml@gha-ios-1.0.0
    with:
      tag: ${{ github.event.inputs.tag }}
      create-github-release: ${{ github.event.inputs.create-github-release == 'true' && 'AEPEdge' || '' }}
      pod-publish-extensions: ${{ github.event.inputs.pod-publish-extensions == 'true' && 'AEPEdge' || '' }}
    secrets: inherit

And multi-extension repos:

name: Release


on: 
  workflow_dispatch:
    inputs:
      tag:
        description: 'Existing tag (version) being released (ex: 5.0.1).'
        required: true
      # this is referring to releasing the extensions
      run_full_release:
        description: 'Run full release process: SPM and podspec validation, build artifacts, GH release (`false` to only check podspec version).'
        required: true
        default: true
        type: boolean

        # this section is referring to pods publishing
      release_AEPServices:
        description: 'Release AEPServices to Cocoapods (`false` to skip).'
        required: true
        default: true
        type: boolean
        
      release_AEPCore:
        description: 'Release AEPCore to Cocoapods (`false` to skip).'
        required: true
        default: true
        type: boolean
        
      release_AEPIdentity:
        description: 'Release AEPIdentity to Cocoapods (`false` to skip).'
        required: true
        default: true
        type: boolean
        
      release_AEPLifecycle:
        description: 'Release AEPLifecycle to Cocoapods (`false` to skip).'
        required: true
        default: true
        type: boolean
        
      release_AEPSignal:
        description: 'Release AEPSignal to Cocoapods (`false` to skip).'
        required: true
        default: true
        type: boolean

jobs:
  set-extensions:
    runs-on: ubuntu-latest
    outputs:
      full_release_extensions: ${{ steps.set-extensions.outputs.full_release_extensions }}
      pod_release_extensions: ${{ steps.set-extensions.outputs.pod_release_extensions }}
    steps:
      - name: Determine Extensions
        id: set-extensions
        run: |
          FULL_RELEASE_EXTENSIONS=""
          POD_RELEASE_EXTENSIONS=""

          # If run_full_release is true, add all extensions to full_release_extensions
          if [ "${{ github.event.inputs.run_full_release }}" == "true" ]; then
            FULL_RELEASE_EXTENSIONS="AEPServices,AEPCore,AEPIdentity,AEPLifecycle,AEPSignal"
          fi

          # Check each pod release input and build the pod_release_extensions string
          if [ "${{ github.event.inputs.release_AEPServices }}" == "true" ]; then
            POD_RELEASE_EXTENSIONS="${POD_RELEASE_EXTENSIONS},AEPServices"
          fi
          if [ "${{ github.event.inputs.release_AEPCore }}" == "true" ]; then
            POD_RELEASE_EXTENSIONS="${POD_RELEASE_EXTENSIONS},AEPCore"
          fi
          if [ "${{ github.event.inputs.release_AEPIdentity }}" == "true" ]; then
            POD_RELEASE_EXTENSIONS="${POD_RELEASE_EXTENSIONS},AEPIdentity"
          fi
          if [ "${{ github.event.inputs.release_AEPLifecycle }}" == "true" ]; then
            POD_RELEASE_EXTENSIONS="${POD_RELEASE_EXTENSIONS},AEPLifecycle"
          fi
          if [ "${{ github.event.inputs.release_AEPSignal }}" == "true" ]; then
            POD_RELEASE_EXTENSIONS="${POD_RELEASE_EXTENSIONS},AEPSignal"
          fi

          # Remove leading comma, if present
          POD_RELEASE_EXTENSIONS="${POD_RELEASE_EXTENSIONS#,}"

          # Output the variables to be used in the next job
          echo "full_release_extensions=$FULL_RELEASE_EXTENSIONS" >> $GITHUB_OUTPUT
          echo "pod_release_extensions=$POD_RELEASE_EXTENSIONS" >> $GITHUB_OUTPUT

  release:
    needs: set-extensions
    uses: timkimadobe/aepsdk-commons/.github/workflows/ios-release.yml@release-script-update
    with:
      tag: ${{ github.event.inputs.tag }}
      create-github-release: ${{ needs.set-extensions.outputs.full_release_extensions }}
      release-dependency-frameworks: AEPRulesEngine
      pod-publish-extensions: ${{ needs.set-extensions.outputs.pod_release_extensions }}
    secrets: inherit

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.

# Conflicts: # .github/workflows/ios-release.yml

…se, dependencies, and published pods

praveek · 2024-10-28T20:25:28Z

.github/workflows/ios-release.yml

-        type: string
+      full_release_extensions:
+        description: |
+          A comma-separated list of extensions for which to run the full release process.


Can you clarify that this will only create a GitHub tag and attach XCFrameworks?

Currently the workflow will not create a release if the tag does not already exist - this is because of the flag --verify-tag in the gh release create command. Please see: adobe/aepsdk-edge-android#171 (comment)

Is creating the tag if it doesn't exist preferred?

And I will also update the description to capture the points you mentioned!

Yes. The tag should be created as part of release process.

I wanted the description to clarify that even though it says full release process, it will just create a GH release and not publish the pods.

Ok thank you! Updated to remove the --verify-tag flag in order to create tag if it doesnt exist on release. Also renamed full_release_extensions -> create-github-release and updated the description to hopefully be more clear about its effects

praveek · 2024-10-28T20:30:39Z

.github/workflows/ios-release.yml

-        description: 'iOS Test App Scheme (ex: TestAppiOS)'
-        required: true
+      extension_dependencies:
+        description: |


I would prefer a better name for this. Can you also clarify the description, as this is a Core-only requirement (since we bundle AEPRulesEngine xcframeworks as part of Core releases) and other extensions shouldn’t use it.

Renamed extension_dependencies -> release-dependency-frameworks and updated the description to be more explicit about core-only requirement

…n release Rename workflow inputs to better describe their purpose Reorder input options for consistency Update input descriptions to better describe their purpose and usage

praveek · 2024-10-29T17:29:42Z

Looks good, can you also update the Core usage example in the description as the variable names don't match the latest implementation.

timkimadobe added 9 commits October 22, 2024 19:04

Update release script to use bools for true/false inputs

650bc21

Fix step check type

dd38f5e

Add license

1b81f9c

Remove archive step env value overrides

463f651

# Conflicts: # .github/workflows/ios-release.yml

Update iOS release script to be able to handle generic lists of relea…

5d87a0a

…se, dependencies, and published pods

Add debug log for podspec publishing

a638acc

Fix incorrect input syntax

c8edbd3

Remove commented out old logic and improve formatting

f85f1cb

Update documentation

1c4e264

timkimadobe requested review from praveek, kevinlind and addb October 23, 2024 02:08

timkimadobe mentioned this pull request Oct 23, 2024

Version script and workflow updates #79

Merged

10 tasks

praveek reviewed Oct 28, 2024

View reviewed changes

timkimadobe added 5 commits October 28, 2024 13:31

Update input variable format to use hyphens for consistency

b22f853

Remove --verify-tag flag to create tag if it does not already exist o…

4ad951d

…n release Rename workflow inputs to better describe their purpose Reorder input options for consistency Update input descriptions to better describe their purpose and usage

Update documentation for consistency and clarity

2d17568

Update step names

9636755

Update step names

4118f54

timkimadobe requested a review from praveek October 29, 2024 04:33

praveek approved these changes Oct 29, 2024

View reviewed changes

timkimadobe merged commit 50147a0 into adobe:main Oct 29, 2024
2 checks passed

timkimadobe deleted the release-script-update2 branch October 29, 2024 22:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update iOS release reusable workflow - handle multi-extension repos #81

Update iOS release reusable workflow - handle multi-extension repos #81

timkimadobe commented Oct 23, 2024 •

edited

Loading

praveek Oct 28, 2024

timkimadobe Oct 28, 2024 •

edited

Loading

praveek Oct 28, 2024 •

edited

Loading

timkimadobe Oct 29, 2024

praveek Oct 28, 2024 •

edited

Loading

timkimadobe Oct 29, 2024

praveek commented Oct 29, 2024

Update iOS release reusable workflow - handle multi-extension repos #81

Update iOS release reusable workflow - handle multi-extension repos #81

Conversation

timkimadobe commented Oct 23, 2024 • edited Loading

Description

Example job runs

Usage examples

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

praveek Oct 28, 2024

Choose a reason for hiding this comment

timkimadobe Oct 28, 2024 • edited Loading

Choose a reason for hiding this comment

praveek Oct 28, 2024 • edited Loading

Choose a reason for hiding this comment

timkimadobe Oct 29, 2024

Choose a reason for hiding this comment

praveek Oct 28, 2024 • edited Loading

Choose a reason for hiding this comment

timkimadobe Oct 29, 2024

Choose a reason for hiding this comment

praveek commented Oct 29, 2024

timkimadobe commented Oct 23, 2024 •

edited

Loading

timkimadobe Oct 28, 2024 •

edited

Loading

praveek Oct 28, 2024 •

edited

Loading

praveek Oct 28, 2024 •

edited

Loading