Sync Branches CI fix (#1246)

* changed checkout ref to target and added base input

* test run

* workflow file ref changed

* change the base branch since main and dev are upto date

* added some logs for debugging

* more logs

* check with correct inputs

* logs and added fetch just in case

* cutting my losses and trying a third party action

* skip ci added

* skip CI inputs added

* remove required from skip_ci input

* apparently $ runs commands in bash

* maybe pipe it

* cutting my loses again

* trying some stuff

* trying something from stackoverflow

* small edits

* smaller edits

* bash is so weird

* message formatting

* input options implemented

* typo fix

* more typo fixes :facepalm

* reverted testing refs

* typo fix

* checking regular git commands if they work

* logs and fetch

* log latest commit

* changed checkout branch at step removed branch log

* log last commit command replaced

* log status

* checkout at base branch

* added git branch to find base branch

* trying more combinations

* updated dev PR checks to trigger with multiple labels

* setup now uses a proper command line parser

* updated workflows with new command line parameters

* updated local scripts with new arguments

* text formatting

* updated release argument

* -r is also already in use, --deploy

* typo fix

* arguments fix for sync verb

* fixed skip ci option

* changed setup ref

* typo fix

* fixing some parsing issues

* added a . at the end of path because git isn't finding path

* logging and trying something I found on git

* more logs and messing with directory

* fixed path

* allow unrelated histories

* empty trigger

* more logging

* typo fixed

* trial without exclusion logic

* reverted changes

* added git log on checkout

* reverted log

* added some merge options

* merging the other way

* reverted reverse merging

* check if history is related

* checking target's last commits

* more logs

* one line logging

* GH actions is running one commit branches :faceplam

* what happens if I force pull do I get all the commits?

* TIL GitHub only fetches one commit from head by default

* revert back testing changes

* added back config input for sync dependencies

* ci shouldn't be skipped on dev (for extra commits)

Author: rob1997

.github/workflows/duplicate_samples.yaml

@@ -3,25 +3,12 @@ name: Duplicate Samples 🪞
 on:
   workflow_call:
   workflow_dispatch:
-    inputs:
-      arguments:
-        required: false
-        description: 'Run Arguments'
-        type: string
-      configuration:
-        required: true
-        description: 'Run Configuration'
-        default: 'Release'
-        type: choice
-        options:
-          - Release
-          - Debug
 
 jobs:
   setup:
     name: Duplicate Samples 🪞
     uses: ChainSafe/web3.unity/.github/workflows/setup.yaml@main
     with:
-      arguments: "-duplicate_samples ${{ github.event.inputs.arguments || '-git:enabled' }} -c ${{ github.event.inputs.configuration || 'Release' }}"
+      arguments: "-d"
     secrets: inherit
 

.github/workflows/pull_request_checks_dev.yml

@@ -9,14 +9,21 @@ on:
       - ready_for_review
 
 jobs:
+  pre_job:
+    name: Pre Job 🚀
+    runs-on: ubuntu-latest
+    if: ${{ github.event.action == 'ready_for_review' || (!github.event.pull_request.draft && contains( github.event.pull_request.labels.*.name, 'ready-to-merge')) }}
+    steps:
+      - run: echo "Proceeding to checks..."
   web3_tests:
     name: Web3 tests 🕸
-    if: ${{ github.event.action == 'ready_for_review' || github.event.label.name == 'ready-to-merge'}}
     uses: ChainSafe/web3.unity/.github/workflows/test.yaml@main
+    needs: [ pre_job ]
   analyze_code:
     name: Analyze 🧐
-    if: ${{ github.event.action == 'ready_for_review' || github.event.label.name == 'ready-to-merge'}}
     uses: ChainSafe/web3.unity/.github/workflows/codeql.yml@main
+    needs: [ pre_job ]
   documentation_check:
     name: Documentation Check 📚
-    uses: ChainSafe/web3.unity/.github/workflows/documentation_check.yml@main
+    uses: ChainSafe/web3.unity/.github/workflows/documentation_check.yml@main
+    needs: [ pre_job ]

.github/workflows/push_checks_main.yml

@@ -9,5 +9,7 @@ jobs:
     name: Sync Branches ♾️
     uses: ChainSafe/web3.unity/.github/workflows/sync_branches.yaml@main
     with:
-      branch: dev
+      base: main
+      target: dev
+      skip_ci: false
     secrets: inherit

.github/workflows/release.yaml

@@ -15,7 +15,7 @@ jobs:
     name: Setup job
     uses: ChainSafe/web3.unity/.github/workflows/setup.yaml@main
     with:
-      arguments: "-release:${{ github.event.inputs.version }}"
+      arguments: "--deploy ${{ github.event.inputs.version }}"
     secrets: inherit
   release:
     name: Release job

.github/workflows/setup.yaml

@@ -6,12 +6,24 @@ on:
       arguments:
         required: true
         type: string
+      configuration:
+        required: false
+        type: string
+        default: "Release"
   workflow_dispatch: 
     inputs:
       arguments:
         required: true
         description: 'Arguments to pass to the setup script'
         type: string
+      configuration:
+        required: true
+        description: 'Run Configuration'
+        default: 'Release'
+        type: choice
+        options:
+          - Release
+          - Debug
 env:
   git_email: "${{ github.actor }}@users.noreply.github.com"
   git_actor: "${{ github.actor }}"
@@ -28,6 +40,7 @@ jobs:
           lfs: true
           ssh-key: ${{ secrets.DEPLOY_KEY }}
           submodules: recursive
+          fetch-depth: 100
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
         with:
@@ -36,10 +49,5 @@ jobs:
       - name: Run
         run: |
           cd Setup
-          dotnet run ${{ inputs.arguments || github.event.inputs.arguments }} Setup/Setup.csproj
-          git reset --hard
-      - name: Cache
-        uses: actions/cache/save@v4
-        with:
-          path: .git
-          key: ${{ runner.os }}-git
+          dotnet run ${{ inputs.arguments || github.event.inputs.arguments }} -c ${{ inputs.configuration || github.event.inputs.configuration }}
+          git reset --hard

.github/workflows/sync_branches.yaml

@@ -1,39 +1,37 @@
-name: Sync Branches
+name: Sync Branches ♾️
 
 on:
   workflow_call:
     inputs:
-      branch:
+      base:
         required: true
         type: string
+      target:
+        required: true
+        type: string
+      skip_ci:
+        type: boolean
+        default: true
   workflow_dispatch:
     inputs:
-      branch:
+      base:
         required: true
-        description: "Branch to Sync"
+        description: "Base branch to Sync"
         type: string
+      target:
+        required: true
+        description: "Target branch to Sync"
+        type: string
+      skip_ci:
+        required: true
+        description: "Should push skip CI"
+        type: boolean
+        default: true
 
 jobs:
   setup:
     name: Sync Branches ♾️
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.head_ref || github.ref_name }}
-          lfs: true
-          ssh-key: ${{ secrets.DEPLOY_KEY }}
-      - name: Sync Branches
-        run: |
-          git config user.email $git_email
-          git config user.name $git_actor
-          git fetch origin ${{ github.event.inputs.branch }}
-          git checkout ${{ github.event.inputs.branch }}
-          git pull
-          git merge main --allow-unrelated-histories
-          git push
-        shell: bash
-        env:
-          git_email: "${{ github.actor }}@users.noreply.github.com"
-          git_actor: "${{ github.actor }}"
+    uses: ChainSafe/web3.unity/.github/workflows/setup.yaml@rob/sync-branches-ci-fix
+    with:
+      arguments: "sync -b ${{ github.event.inputs.base || inputs.base }} -t ${{ github.event.inputs.target || inputs.target }} -s ${{ github.event.inputs.skip_ci || inputs.skip_ci }}"
+    secrets: inherit

.github/workflows/sync_dependencies.yaml

@@ -4,10 +4,6 @@ on:
   workflow_call:
   workflow_dispatch:
     inputs:
-      arguments:
-        required: false
-        description: 'Run Arguments'
-        type: string
       configuration:
         required: true
         description: 'Run Configuration'
@@ -22,6 +18,7 @@ jobs:
     name: Sync Dependencies 🔄
     uses: ChainSafe/web3.unity/.github/workflows/setup.yaml@main
     with:
-      arguments: "-sync_dependencies ${{ github.event.inputs.arguments || '-git:enabled' }} -c ${{ github.event.inputs.configuration || 'Release' }}"
+      arguments: "-s"
+      configuration: ${{ github.event.inputs.configuration || 'Release' }}
     secrets: inherit
 

Setup/DefaultOptions.cs

@@ -0,0 +1,47 @@
+using System.Collections.Generic;
+using CommandLine;
+using Setup.Utils;
+
+namespace Setup;
+
+[Verb("do", true, HelpText = "Runs default options.")]
+public class DefaultOptions
+{
+    [Option('s', "sync_dependencies", Required = false, Default = false, HelpText = "Generate and copy dependencies to Sample Project.")]
+    public bool SyncDependencies { get; set; }
+    
+    [Option('d', "duplicate_samples", Required = false, Default = false, HelpText = "Duplicate samples in Sample Project into package samples.")]
+    public bool DuplicateSamples { get; set; }
+    
+    [Option("deploy", Required = false, HelpText = "Version to release.")]
+    public string Release { get; set; }
+    
+    [Option('g', "git", Required = false, Default = true, HelpText = "Enable Git.")]
+    public bool? EnableGit { get; set; }
+
+    public List<IRunnable> GetRunnableList()
+    {
+        List<IRunnable> runnableList = new List<IRunnable>();
+        
+        if (SyncDependencies)
+        {
+            runnableList.Add(new SyncDependencies());
+        }
+
+        if (DuplicateSamples)
+        {
+            runnableList.Add(new DuplicateSamples());
+        }
+
+        if (!string.IsNullOrEmpty(Release))
+        {
+            runnableList.Add(new Release(Release));
+        }
+
+        EnableGit ??= false;
+        
+        runnableList.Add(new Git(EnableGit.Value));
+
+        return runnableList;
+    }
+}