Update GitHub Action workflows to use aepsdk-commons #171

timkimadobe · 2024-10-24T01:10:22Z

Description

This PR migrates the local GitHub Action workflows to use the reusable workflows available in aepsdk-commons. At a high level:

The reusable workflows are tagged per platform in aepsdk-commons (ex: gha-android-1.0.0), which the workflows use for controlling which version of the workflow is used
The same style of manual workflow inputs has been generally preserved, and the goal is to abstract away the usage of the reusable workflows

update-version.yml

The optional dependency list has expanded based on all of the existing dependencies in gradle.properties today

maven-release.yml

Edge Identity dependency version has been added as a validation requirement for the release

Note

Due to current GitHub Actions YAML limitations, YAML anchors are not available, meaning that the workflow tag and input value must be maintained simultaneously. However, they are planning on adding this in 2025.
Source: actions/runner#1182

Example job runs

Note

These runs were performed in my fork of the repo, also referencing the workflows in my fork of aepsdk-commons (to avoid cross-repo checkout token permission requirements)

Update versions (no dependencies):

Update versions (dependencies AND targeting different branch dev - demonstrating you can update versions in any branch):

Publish release (failed because no secrets for publishing available in fork):

Job run: https://github.com/timkimadobe/aepsdk-edge-android/actions/runs/11490639786/job/31981684268

Publish snapshot (failed because no secrets for publishing available in fork):

Job run: https://github.com/timkimadobe/aepsdk-edge-android/actions/runs/11490687754/job/31981819389

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.

addb · 2024-10-24T20:57:45Z

.github/workflows/maven-release.yml

@@ -15,62 +15,29 @@ on:
  workflow_dispatch:
    inputs:
      tag:
-        description: 'tag/version'
+        description: 'The existing tag (version) to be released (ex: 5.0.1).'


tag will be created with the workflow, so "The existing tag ..." might sound confusing.

The release workflow is currently using the --verify-tag flag which:

Abort in case the git tag doesn't already exist in the remote repository
docs: https://cli.github.com/manual/gh_release_create

This is true for both iOS and Android release workflows - I was thinking it could be beneficial to make creating the release tag explicit, in order to avoid accidentally publishing unintended changes/branch states. What do you think?

See example release failure due to missing tag + this flag here: https://github.com/timkimadobe/aepsdk-edge-android/actions/runs/11507608386/job/32034124666

I was under the impression create GH release creates the tag and release. Isn't that the case?

addb · 2024-10-24T21:00:33Z

.github/workflows/maven-release.yml

+        default: true
+
+      edge-identity-dependency:
+        description: 'The AEPEdgeIdentity dependency version in gradle.properties to be validated (ex: 3.0.1).'


nit: Here we use ex: 3.0.1 the L18 tag has ex: 5.0.1

let's keep example versions also consistent and probably to latest major version i.e. 3.x

I see 3.0.1 in rest of the PR so let's use 3.0.1 everywhere.

Actually what do you think about using a generic 1.2.3 everywhere instead?

This reverts commit 036833c.

.github/workflows/update-version.yml

Add code documentation to explicitly mention tags must match

.github/workflows/update-version.yml

kevinlind · 2024-10-29T20:48:04Z

.github/workflows/update-version.yml

@@ -1,48 +1,56 @@
-#


Keep the copyright header for this file.

Thank you! Added back

kevinlind · 2024-10-29T20:57:25Z

.github/workflows/update-version.yml


      core-dependency:
-        description: '[Optional] Update Core dependency in pom.xml. Example: 3.0.0'
+        description: 'If a version is provided, update AEPCore dependency in gradle.properties (ex: 1.2.3).'


Specify that this is a dependency in the pom.xml file, so users know this is a published dependency.

Thank you! Added the additional context to the description as suggested

kevinlind · 2024-10-29T20:57:56Z

.github/workflows/update-version.yml


-      identity-dependency:
-        description: '[Optional] Update Edge Identity dependency in pom.xml. Example: 3.0.0'
+      edge-identity-dependency:


Specify that this is a dependency in the pom.xm file, so users know this is a publish dependency.

kevinlind · 2024-10-29T20:59:05Z

.github/workflows/update-version.yml

-  update-version:
-    runs-on: ubuntu-latest
+      edge-consent-dependency:
+        description: 'If a version is provided, update AEPEdgeConsent dependency in gradle.properties (ex: 1.2.3).'


Specify this is a testing only dependency.

kevinlind · 2024-10-29T20:59:22Z

.github/workflows/update-version.yml

-    - name: Update Edge
-      run: (./scripts/version.sh -u -v ${{ github.event.inputs.version }} -d "Core ${{ github.event.inputs.core-dependency }}, EdgeIdentity ${{ github.event.inputs.identity-dependency }}")
+      testutils-dependency:
+        description: 'If a version is provided, update AEPTestUtils dependency in gradle.properties (ex: 1.2.3).'


Specify this is a testing only dependency.

…dependency context

timkimadobe

Thanks for the review @kevinlind! Updated based on feedback

timkimadobe · 2024-10-29T22:59:51Z

.github/workflows/update-version.yml

@@ -1,48 +1,56 @@
-#


Thank you! Added back

timkimadobe · 2024-10-29T23:03:23Z

.github/workflows/update-version.yml


      core-dependency:
-        description: '[Optional] Update Core dependency in pom.xml. Example: 3.0.0'
+        description: 'If a version is provided, update AEPCore dependency in gradle.properties (ex: 1.2.3).'


Thank you! Added the additional context to the description as suggested

timkimadobe · 2024-10-29T23:03:27Z

.github/workflows/update-version.yml

-  update-version:
-    runs-on: ubuntu-latest
+      edge-consent-dependency:
+        description: 'If a version is provided, update AEPEdgeConsent dependency in gradle.properties (ex: 1.2.3).'


timkimadobe · 2024-10-29T23:03:31Z

.github/workflows/update-version.yml

-    - name: Update Edge
-      run: (./scripts/version.sh -u -v ${{ github.event.inputs.version }} -d "Core ${{ github.event.inputs.core-dependency }}, EdgeIdentity ${{ github.event.inputs.identity-dependency }}")
+      testutils-dependency:
+        description: 'If a version is provided, update AEPTestUtils dependency in gradle.properties (ex: 1.2.3).'


timkimadobe · 2024-10-29T23:03:43Z

.github/workflows/update-version.yml


-      identity-dependency:
-        description: '[Optional] Update Edge Identity dependency in pom.xml. Example: 3.0.0'
+      edge-identity-dependency:


timkimadobe · 2024-11-08T22:23:39Z

Final checks using production tag (gha-android-3.0.0):

Update versions (with dependencies): timkimadobe/aepsdk-edge-ios#48

Resulting PR: Updating version to 1.2.7 timkimadobe/aepsdk-edge-ios#48

Snapshot: https://github.com/timkimadobe/aepsdk-edge-android/actions/runs/11750087816/job/32737627821

Fails due to missing GPG key

Release: https://github.com/timkimadobe/aepsdk-edge-android/actions/runs/11750418141/job/32738633511

Fails due to missing GPG key
Tag check has been updated to reflect Android style "v" prefix tags

timkimadobe added 5 commits October 23, 2024 16:13

Update update versions workflow to use aepsdk-commons reusable workflow

d6ced6e

Update maven release and snapshot workflows to use reusable workflows

9386c93

Add workflow_tag input

260ff4c

Add pr permissions

c50df5d

Update config to prod

4b873ea

timkimadobe requested review from kevinlind, addb and cacheung October 24, 2024 01:11

addb reviewed Oct 24, 2024

View reviewed changes

Apply testing config

036833c

timkimadobe requested a review from addb October 24, 2024 21:22

timkimadobe added 4 commits October 24, 2024 16:24

Revert "Apply testing config"

a35eb5a

This reverts commit 036833c.

Update example versions to 1.2.3 for consistency

1f355bf

Update input ordering for consistency

ded1168

Update doc styling

2b7b5c7

cacheung reviewed Oct 25, 2024

View reviewed changes

.github/workflows/update-version.yml Outdated Show resolved Hide resolved

Fix tagged version used for update version workflow

e21e498

Add code documentation to explicitly mention tags must match

cacheung reviewed Oct 25, 2024

View reviewed changes

.github/workflows/update-version.yml Show resolved Hide resolved

timkimadobe mentioned this pull request Oct 25, 2024

Update GitHub Action workflows to use aepsdk-commons adobe/aepsdk-edge-ios#507

Merged

10 tasks

cacheung approved these changes Oct 25, 2024

View reviewed changes

timkimadobe mentioned this pull request Oct 28, 2024

Update iOS release reusable workflow - handle multi-extension repos adobe/aepsdk-commons#81

Merged

10 tasks

kevinlind reviewed Oct 29, 2024

View reviewed changes

timkimadobe added 2 commits October 29, 2024 15:59

Add license header back to update version workflow

f80795b

Update update version workflow input descriptions to better describe …

fd32eb0

…dependency context

timkimadobe commented Oct 29, 2024

View reviewed changes

timkimadobe requested a review from kevinlind October 29, 2024 23:11

kevinlind approved these changes Oct 30, 2024

View reviewed changes

timkimadobe added 2 commits October 30, 2024 16:59

Update parameter name to latest

07bd896

Switch description multiline type

b44f528

timkimadobe added 5 commits October 30, 2024 17:03

Remove default from mandatory fields to trigger error on empty submit

8739d7e

Update to latest version of reusable workflow format

6bb8b95

Apply testing config

768a412

Update input descriptions

4cbe66c

Update to production tag

678b39b

Update to final production config

3f25594

timkimadobe merged commit 11a391e into adobe:dev Nov 8, 2024
6 checks passed

This was referenced Nov 22, 2024

Dev -> Staging [NON-RELEASE] Migrate to GitHub Actions reusable workflows #176

Merged

Staging -> Main [NON-RELEASE] Migrate to GitHub Actions reusable workflows #177

Merged

timkimadobe deleted the reusable-workflows branch November 27, 2024 01:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update GitHub Action workflows to use aepsdk-commons #171

Update GitHub Action workflows to use aepsdk-commons #171

timkimadobe commented Oct 24, 2024 •

edited

Loading

addb Oct 24, 2024

timkimadobe Oct 24, 2024 •

edited

Loading

addb Oct 29, 2024

addb Oct 24, 2024

addb Oct 24, 2024

timkimadobe Oct 24, 2024

addb Oct 29, 2024

kevinlind Oct 29, 2024

timkimadobe Oct 29, 2024

kevinlind Oct 29, 2024

timkimadobe Oct 29, 2024

kevinlind Oct 29, 2024

timkimadobe Oct 29, 2024

kevinlind Oct 29, 2024

timkimadobe Oct 29, 2024

kevinlind Oct 29, 2024

timkimadobe Oct 29, 2024

timkimadobe left a comment

timkimadobe Oct 29, 2024

timkimadobe Oct 29, 2024

timkimadobe Oct 29, 2024

timkimadobe Oct 29, 2024

timkimadobe Oct 29, 2024

timkimadobe commented Nov 8, 2024

Update GitHub Action workflows to use aepsdk-commons #171

Update GitHub Action workflows to use aepsdk-commons #171

Conversation

timkimadobe commented Oct 24, 2024 • edited Loading

Description

Example job 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

timkimadobe Oct 24, 2024 • edited Loading

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

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

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

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

Choose a reason for hiding this comment

timkimadobe commented Nov 8, 2024

timkimadobe commented Oct 24, 2024 •

edited

Loading

timkimadobe Oct 24, 2024 •

edited

Loading