Migrate to GitHub Actions reusable workflows #733

timkimadobe · 2025-01-30T08:05:09Z

Description

This PR migrates the Core Android repo to use the reusable workflows available in aepsdk-commons

`build-and-test.yml`

A migration from CircleCI to GitHub Actions

The build artifacts for each extension are saved using a unique time stamp for uniqueness
New Makefile rules have been created for CI compatibility
- ci-lint: checkstyle checkformat
- integration-test-coverage: integration-test
- javadoc: core-javadoc
Example PR with checks: Trigger CI4 timkimadobe/aepsdk-core-android#6
Job overview (with artifacts, logs, codecov reports, etc): https://github.com/timkimadobe/aepsdk-core-android/actions/runs/13044629358?pr=6

`maven-release.yml`

For non-Core extensions, Core dependency version validation has been added as a requirement
Example run (Core): https://github.com/timkimadobe/aepsdk-core-android/actions/runs/13083453693
- Resulting GitHub release: https://github.com/timkimadobe/aepsdk-core-android/releases/tag/v3.2.0-core (note generated release notes rely on PRs which are defined in the main repo, not the fork so no auto generated notes are available with this example)
Example run (Signal, with Core dependency version validation): https://github.com/timkimadobe/aepsdk-core-android/actions/runs/13083457011
- Resulting GitHub release: https://github.com/timkimadobe/aepsdk-core-android/releases/tag/v3.0.0-signal

`maven-snapshot.yml`

Same multi-release method possible
Example run: https://github.com/timkimadobe/aepsdk-core-android/actions/runs/13047641220

`update-version.yml`

Unfortunately, the simultaneous version update in a single PR isn't possible with the current workflow; the inputs have been updated to a choice system similar to maven-release.yml
- However, post migration, it could still support simultaneous version uploading in the manual job dispatch - it's just that the resulting PRs will be separate
Example run: https://github.com/timkimadobe/aepsdk-core-android/actions/runs/13048168779
Resulting PR: Updating Core version to 7.8.9 timkimadobe/aepsdk-core-android#11

Questions for reviewers

Does Core have an assemble-app rule? I couldn't find one in the existing CircleCI workflow, so I did not include it in the migration.
Should the maven-release.yml also validate the constants files for the given extension being released too? Currently it only validates the gradle.properties value

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.

Update build and test workflow to fix javadoc path, and use new param for artifact timestamp

Rename component to extension Delete migrated files

codecov · 2025-01-31T01:50:15Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.01%. Comparing base (66316d1) to head (8357f6c).
Report is 3 commits behind head on dev.

❌ Your project status has failed because the head coverage (66.01%) is below the target coverage (75.00%). You can increase the head coverage or adjust the target coverage.

❗ There is a different number of reports uploaded between BASE (66316d1) and HEAD (8357f6c). Click for more details.

HEAD has 5 uploads less than BASE

Flag BASE (66316d1) HEAD (8357f6c)

unit-tests 4 0

functional-tests 1 0

Additional details and impacted files

@@              Coverage Diff              @@
##                dev     #733       +/-   ##
=============================================
- Coverage     81.59%   66.01%   -15.58%     
+ Complexity     2141     2020      -121     
=============================================
  Files           194      216       +22     
  Lines          8937    10633     +1696     
  Branches       1121     1384      +263     
=============================================
- Hits           7292     7019      -273     
- Misses         1091     3068     +1977     
+ Partials        554      546        -8

Flag	Coverage Δ
android-functional-tests	`27.65% <ø> (?)`
android-unit-tests	`61.46% <ø> (?)`
functional-tests	`?`
unit-tests	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

see 37 files with indirect coverage changes

praveek · 2025-01-31T19:45:54Z

.github/workflows/maven-release.yml

+      release-variant: ${{ github.event.inputs.extension }}
+      version-validation-name: ${{ github.event.inputs.extension }}
+      version-validation-paths: code/gradle.properties:properties_multi_module


Can you also add validation for version in code files so that we don't miss it during the release?

Updated!

Job run examples with the new validation in the PR description under maven release notes

Log snippets:

Signal release example validation:

Validating version is 3.0.0 ---- Validating versions in 'Signal.java' ---- * File path: /home/runner/work/aepsdk-core-android/aepsdk-core-android/code/signal/src/phone/java/com/adobe/marketing/mobile/Signal.java PASS 'EXTENSION_VERSION' with pattern `re.compile('(^[\\s\\S]*String EXTENSION_VERSION\\s*=\\s*")([0-9]+\\.[0-9]+\\.[0-9]+)')` matches '3.0.0' in 'Signal.java' All versions are correct!

Core release example validation:

Validating version is 3.2.0 ---- Validating versions in 'CoreConstants.kt' ---- * File path: /home/runner/work/aepsdk-core-android/aepsdk-core-android/code/core/src/main/java/com/adobe/marketing/mobile/internal/CoreConstants.kt PASS 'VERSION' with pattern `re.compile('(^[\\s\\S]*const val VERSION\\s*=\\s*")([0-9]+\\.[0-9]+\\.[0-9]+)')` matches '3.2.0' in 'CoreConstants.kt' All versions are correct!

… versions

praveek · 2025-02-03T22:51:28Z

@timkimadobe I noticed that the new workflow is missing the api-check we run. Could you add it to the build workflow?

timkimadobe · 2025-02-05T22:20:48Z

@praveek Thank you for catching that! Updated to include that check in the CI workflow

See successful make api-check run from the latest commit here:

https://github.com/adobe/aepsdk-core-android/actions/runs/13167650134/job/36751507160?pr=733

timkimadobe added 7 commits January 29, 2025 15:29

Apply testing config

9faf5e6

Apply testing config 2

b6cfdfe

Update makefile rules for CI compatibility

47cb9ee

Add javadoc alias for Core

9b118b2

Update build and test workflow to fix javadoc path, and use new param for artifact timestamp

Apply prod config

4b60d57

TEMP: apply testing config

3dfcd2a

Fix release workflow by adding required if checks

4a043cc

timkimadobe requested review from praveek and prudrabhat January 30, 2025 08:05

timkimadobe added 3 commits January 30, 2025 00:14

Fix update version to include constants files

9ff84e7

Rename component to extension Delete migrated files

Apply prod config

1ba62d7

Update lint rule name

7f3dc36

timkimadobe mentioned this pull request Jan 30, 2025

Add template regex support for primary extension in version workflows adobe/aepsdk-commons#110

Merged

10 tasks

Update to properties_multi_module

18bd671

praveek reviewed Jan 31, 2025

View reviewed changes

Update release workflow to also validate constants and extension file…

cdd4cb7

… versions

timkimadobe requested a review from praveek February 1, 2025 01:07

Add API check step in CI check

8357f6c

praveek approved these changes Feb 5, 2025

View reviewed changes

timkimadobe merged commit 5762bfc into adobe:dev Feb 5, 2025
22 of 24 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Migrate to GitHub Actions reusable workflows #733

Migrate to GitHub Actions reusable workflows #733

Uh oh!

timkimadobe commented Jan 30, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jan 31, 2025 •

edited

Loading

Uh oh!

praveek Jan 31, 2025

Uh oh!

timkimadobe Feb 1, 2025

Uh oh!

praveek commented Feb 3, 2025 •

edited

Loading

Uh oh!

timkimadobe commented Feb 5, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Migrate to GitHub Actions reusable workflows #733

Migrate to GitHub Actions reusable workflows #733

Uh oh!

Conversation

timkimadobe commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

build-and-test.yml

maven-release.yml

maven-snapshot.yml

update-version.yml

Questions for reviewers

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

codecov bot commented Jan 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

praveek Jan 31, 2025

Choose a reason for hiding this comment

Uh oh!

timkimadobe Feb 1, 2025

Choose a reason for hiding this comment

Uh oh!

praveek commented Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

timkimadobe commented Feb 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

timkimadobe commented Jan 30, 2025 •

edited

Loading

`build-and-test.yml`

`maven-release.yml`

`maven-snapshot.yml`

`update-version.yml`

codecov bot commented Jan 31, 2025 •

edited

Loading

praveek commented Feb 3, 2025 •

edited

Loading

timkimadobe commented Feb 5, 2025 •

edited

Loading