Initial version of bridges pallet as subtree of https://github.com/pa…

…ritytech/parity-bridges-common

Added `Bridges subtree files` pr review rule

.github/pr-custom-review.yml

@@ -19,12 +19,20 @@ rules:
     check_type: changed_files
     condition:
       include: .*
-      # excluding files from 'Runtime files' and 'CI files' rules
+      # excluding files from 'Runtime files' and 'CI files' rules and `Bridges subtree files`
       exclude: ^parachains/runtimes/assets/(statemine|statemint)/src/[^/]+\.rs$|^parachains/runtimes/bridge-hubs/(bridge-hub-kusama|bridge-hub-polkadot)/src/[^/]+\.rs$|^parachains/runtimes/collectives/collectives-polkadot/src/[^/]+\.rs$|^parachains/common/src/[^/]+\.rs$|^\.gitlab-ci\.yml|^scripts/ci/.*|^\.github/.*
     min_approvals: 2
     teams:
       - core-devs
 
+  # if there are any changes in the bridges subtree (in case of backport changes back to bridges repo)
+  - name: Bridges subtree files
+    check_type: changed_files
+    condition: ^bridges/.*
+    min_approvals: 1
+    teams:
+      - bridges-core
+
   - name: CI files
     check_type: changed_files
     condition:

Cargo.toml

@@ -2,6 +2,11 @@
 resolver = "2"
 
 members = [
+	"bridges/bin/runtime-common",
+	"bridges/modules/grandpa",
+	"bridges/modules/messages",
+	"bridges/modules/parachains",
+	"bridges/modules/relayers",
 	"client/cli",
 	"client/consensus/aura",
 	"client/consensus/common",

parachains/runtimes/bridge-hubs/README.md

@@ -35,3 +35,41 @@ or
 # BridgeHubPolkadot
 zombienet-linux --provider native spawn ./zombienet/examples/bridge_hub_polkadot_local_network.toml
 ```
+
+----
+## Git subtree `./bridges`
+
+Add Bridges repo as a local remote and synchronize it with latest `master` from bridges repo:
+
+### How to update `bridges` subtree
+```
+cd <cumulus-git-repo-dir>
+# this will update new git branches from bridges repo
+# there could be unresolved conflicts, but dont worry,
+# lots of them are caused because of removed unneeded files with patch step :)
+# so before solving conflicts just run patch
+./scripts/bridges_update_subtree.sh fetch
+# this will remove unneeded files and checks if subtree modules compiles
+./scripts/bridges_update_subtree.sh patch
+# if there are conflicts, this could help, removes locally deleted files at least
+# (but you can also do this manually)
+./scripts/bridges_update_subtree.sh merge
+# when conflicts resolved, you can check build again - should pass
+# also important: this updates global Cargo.lock
+./scripts/bridges_update_subtree.sh patch
+````
+We use `--squash` to avoid adding individual commits and rather squashing them
+all into one.
+Now we use `master` branch, but in future, it could change to some release branch/tag.
+
+### How was first time initialized (does not need anymore)
+```
+cd <cumulus-git-repo-dir>
+git remote add -f bridges git@github.com:paritytech/parity-bridges-common.git
+# (ran just only first time, when subtree was initialized)
+git subtree add --prefix=bridges bridges master --squash
+# remove unnecessery files
+./scripts/bridges_update_subtree.sh patch
+./scripts/bridges_update_subtree.sh merge
+git commit --amend
+```

scripts/bridges_update_subtree.sh

@@ -0,0 +1,85 @@
+#!/bin/bash
+
+# A script to udpate bridges repo as subtree to Cumulus
+# Usage:
+#       ./scripts/bridges_update_subtree.sh fetch
+#       ./scripts/bridges_update_subtree.sh patch
+#       ./scripts/bridges_update_subtree.sh merge
+
+set -e
+
+BRIDGES_BRANCH="${BRANCH:-master}"
+BRIDGES_TARGET_DIR="${TARGET_DIR:-bridges}"
+
+function fetch() {
+    # the script is able to work only on clean git copy
+    [[ -z "$(git status --porcelain)" ]] || {
+        echo >&2 "The git copy must be clean (stash all your changes):";
+        git status --porcelain
+        exit 1;
+    }
+
+    local bridges_remote=$(git remote -v | grep "parity-bridges-common.git (fetch)" | head -n1 | awk '{print $1;}')
+    if [ -z "$bridges_remote" ]; then
+        echo ""
+        echo "Adding new remote: 'bridges' repo..."
+        echo ""
+        echo "... check your YubiKey ..."
+        git remote add -f bridges git@github.com:paritytech/parity-bridges-common.git
+        bridges_remote="bridges"
+    else
+        echo ""
+        echo "Fetching remote: '${bridges_remote}' repo..."
+        echo ""
+        echo "... check your YubiKey ..."
+        git fetch ${bridges_remote} --prune
+    fi
+
+    echo ""
+    echo "Syncing/updating subtree with remote branch '${bridges_remote}/$BRIDGES_BRANCH' to target directory: '$BRIDGES_TARGET_DIR'"
+    echo ""
+    echo "... check your YubiKey ..."
+    git subtree pull --prefix=$BRIDGES_TARGET_DIR ${bridges_remote} $BRIDGES_BRANCH --squash
+}
+
+function patch() {
+    echo ""
+    echo "Patching/removing unneeded stuff from subtree in target directory: '$BRIDGES_TARGET_DIR'"
+    $BRIDGES_TARGET_DIR/scripts/verify-pallets-build.sh --ignore-git-state --no-revert
+}
+
+function merge() {
+    echo ""
+    echo "Merging stuff from subtree in target directory: '$BRIDGES_TARGET_DIR'"
+
+    # stage all removed by patch: DU, MD, D, AD - only from subtree directory
+    git status -s | awk '$1 == "DU" || $1 == "D" || $1 == "MD" || $1 == "AD" {print $2}' | grep "^$BRIDGES_TARGET_DIR/" | xargs git rm -q --ignore-unmatch
+
+    echo ""
+    echo "When all conflicts are resolved, do 'git merge --continue'"
+}
+
+function amend() {
+    echo ""
+    echo "Amend stuff from subtree in target directory: '$BRIDGES_TARGET_DIR'"
+    git commit --amend -S -m "updating bridges subtree + remove extra folders"
+}
+
+case "$1" in
+    fetch)
+        fetch
+        ;;
+    patch)
+        patch
+        ;;
+    merge)
+        merge
+        ;;
+    amend)
+        amend
+        ;;
+    all)
+        fetch
+        patch
+        ;;
+esac