Merge pull request #14 from paritytech/common-base

Bring main branch up to date

Author: dmitry-markin

.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,4 @@
-name: Check Set-Up & Build
+name: CI
 
 # Controls when the action will run.
 on:
@@ -11,33 +11,74 @@ on:
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+# Cancel previous runs
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+# Parity CI image to use
+# Common variable is defined in the workflow
+# Repo env variable doesn't work for PRs from forks
+env:
+  CI_IMAGE: "paritytech/ci-unified:bullseye-1.84.1-2025-01-28-v202502131220"
+
 jobs:
-  check:
-    # The type of runner that the job will run on
-    runs-on: ubuntu-22.04
+  set-image:
+    # This workaround sets the container image for each job using 'set-image' job output.
+    # env variables don't work for PRs from forks, so we need to use outputs.
+    runs-on: ubuntu-latest
+    outputs:
+      CI_IMAGE: ${{ steps.set_image.outputs.CI_IMAGE }}
+    steps:
+      - id: set_image
+        run: echo "CI_IMAGE=${{ env.CI_IMAGE }}" >> $GITHUB_OUTPUT
 
-    # Steps represent a sequence of tasks that will be executed as part of the job
+  check:
+    name: Cargo check
+    runs-on: ubuntu-latest
+    needs: [set-image]
+    container:
+      image: ${{ needs.set-image.outputs.CI_IMAGE }}
     steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v3
+      - name: Checkout sources
+        uses: actions/checkout@v4
 
-      - name: Install linux dependencies
-        run: sudo apt-get install -y clang libssl-dev llvm libudev-dev protobuf-compiler
-
-      - name: Install Rust
-        run: |
-          rustup update stable --no-self-update
-          rustup target add wasm32-unknown-unknown
+      - name: Install Rust stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
 
       # Rust cache
-      - uses: Swatinem/rust-cache@v2
+      - name: Rust cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+          cache-all-crates: true
 
-      - name: Check Build
+      - name: Cargo check
         run: |
-          SKIP_WASM_BUILD=1 cargo check --release
+          SKIP_WASM_BUILD=1 cargo check
+
+  check-benchmarking:
+    name: Cargo check (benchmarking)
+    runs-on: ubuntu-latest
+    needs: [set-image]
+    container:
+      image: ${{ needs.set-image.outputs.CI_IMAGE }}
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      # Rust cache
+      - name: Rust cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+          cache-all-crates: true
 
-      - name: Check Build for Benchmarking
+      - name: Cargo check (benchmarking)
         run: >
-          pushd node &&
-          cargo check --features=runtime-benchmarks --release
+          cd node &&
+          cargo check --features=runtime-benchmarks

.github/workflows/check.yml

@@ -0,0 +1,46 @@
+# Using Parity Bridges Common dependency (`git subtree`).
+
+In `./bridges` sub-directory you can find a `git subtree` imported version of:
+[parity-bridges-common](https://github.com/paritytech/parity-bridges-common/) repository.
+
+# How to pull latest Bridges code to the `bridges` subtree
+(in practice)
+
+The `bridges` repo has a stabilized branch `polkadot-v.1.0.0-audited` dedicated for releasing
+and based on Polkadot v1.0.0 code.
+
+```
+cd <polkadot-bulletin-chain-git-repo-dir>
+
+# needs to be done only once
+git remote add -f bridges https://github.com/paritytech/parity-bridges-common.git
+
+# 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,
+git fetch bridges --prune
+git subtree pull --prefix=bridges bridges polkadot-v.1.0.0-audited --squash
+
+# if the command above fails with the "Can't squash-merge: 'bridges' was never added" or
+# "fatal: refusing to merge unrelated histories" error, use this:
+# git merge -s subtree -Xsubtree="bridges" bridges/polkadot-v.1.0.0-audited --allow-unrelated-histories --squash
+
+# so, after fetch and before solving conflicts just run patch,
+# this will remove unneeded files and checks if subtree modules compiles
+#
+# if it fails to build, you'll need to resolve conflicts manually
+./bridges/scripts/verify-pallets-build.sh --ignore-git-state --no-revert
+
+# if there are conflicts, this could help,
+# this removes locally deleted files at least (move changes to git stash for commit)
+git status -s | awk '$1 == "DU" || $1 == "D" || $1 == "MD" || $1 == "AD" {print $2}' | grep "^bridges/" | xargs git rm -q --ignore-unmatch
+
+# (optional) when conflicts resolved, you can check build again - should pass
+# also important: this updates global Cargo.lock
+git commit --amend -S -m "updating bridges subtree + remove extra folders"
+
+# add changes to the commit, first command `fetch` starts merge,
+# so after all conflicts are solved and patch passes and compiles,
+# then we need to finish merge with:
+git merge --continue
+````