feat: cherry pick improvements

[Garzas]

---

PR Submission Checklist for internal contributors

• The PR Title

  • conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
  • contains a reference JIRA issue number like SQPIT-764
  • answers the question: If merged, this PR will: ... ³

• The PR Description

  • is free of optional paragraphs and you have filled the relevant parts to the best of your ability

---

What's new in this PR?

Issues

• The need to enhance the flexibility and functionality of the GitHub Action script that automates the cherry-picking of merged PRs from the release/candidate branch.

Causes (Optional)

• The previous script had limitations in terms of configurability, lacked descriptive comments, and didn't handle submodule updates optimally.

Solutions

1. Descriptive Comments:

   • Added a comprehensive comment section at the beginning of the script. This section describes its purpose, the sequence of operations, and any prerequisites.

2. Environment Variables:

   • Introduced the SUBMODULE_NAME to allow dynamic handling based on the submodule's presence.
   • Added the TARGET_BRANCH variable, enabling users to specify a different branch for cherry-picking rather than the default develop.

3. Dynamic Submodule Handling:

   • Enhanced the script to check changes based on the presence or absence of SUBMODULE_NAME. If set, the script focuses on changes outside that submodule; otherwise, it considers all changes.

4. Submodule Update:

   • Embedded a step to update the submodule to its latest version from the target branch, provided a submodule name is specified.

5. Squashing Commits:

   • Implemented commit squashing for submodule updates. This ensures a cleaner commit history by merging the submodule update commit with the merged PR's commit message.

6. Cherry-pick Strategy Adjustment:

   • Modified the cherry-pick strategy to use --strategy-option theirs. This favors the changes from the PR being cherry-picked during conflicts.
   • Explicitly committed any unresolved merge conflicts to ensure they are highlighted for manual resolution.

7. Improved Conflict Handling:

   • Enhanced the conflict detection mechanism. The script now identifies files with unresolved conflicts and adds this info to the PR body.

8. Temporary Branch Cleanup:

   • After performing certain operations on a temporary branch, the script now ensures its deletion, maintaining a clean repository state.

Dependencies (Optional)

If there are some other pull requests related to this one (e.g. new releases of frameworks), specify them here.

Needs releases with:

• GitHub link to other pull request

Testing

Test Coverage (Optional)

• I have added automated test to this contribution

How to Test

Briefly describe how this change was tested and if applicable the exact steps taken to verify that it works as expected.

Notes (Optional)

Specify here any other facts that you think are important for this issue.

Attachments (Optional)

Attachments like images, videos, etc. (drag and drop in the text box)

---

PR Post Submission Checklist for internal contributors (Optional)

• Wire's Github Workflow has automatically linked the PR to a JIRA issue

---

PR Post Merge Checklist for internal contributors

• If any soft of configuration variable was introduced by this PR, it has been added to the relevant documents and the CI jobs have been updated.

---

References

1. https://sparkbox.com/foundry/semantic_commit_messages
2. https://github.com/wireapp/.github#usage
3. E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

[github-actions]

Test Results

629 tests  ±0   629 ✔️ ±0   7m 18s ⏱️ - 2m 27s
  92 suites ±0       0 💤 ±0 
  92 files   ±0       0 ❌ ±0 

Results for commit 708a6d4. ± Comparison against base commit 3522b4a.

♻️ This comment has been updated with latest results.

[github-actions]

APKs built during tests are available here. Scroll down to Artifacts!

[AndroidBob]

Build 1125 succeeded.

The build produced the following APK's:

• com.wire.android-v4.5.0(7735116)(7735116)-staging-compat.apk

[github-actions]

APKs built during tests are available here. Scroll down to Artifacts!

[github-actions]

APKs built during tests are available here. Scroll down to Artifacts!

[AndroidBob]

Build 1155 succeeded.

The build produced the following APK's:

• com.wire.android-v4.5.0(7751716)(7751716)-staging-compat.apk

[vitorhugods]

LGTM

Really great. Awesome work

I wonder if we could make it an action of its own tho. Future improvement, maybe.

In a way that it would be easy to just create a wokflow file and add the action with parameters and voilà.