Merge pull request #22 from w3f/better-educhain-upgrade

EduChain Template Upgrade

.github/actions/free-disk-space/action.yml

@@ -0,0 +1,16 @@
+name: Free disk space
+description: We've run into out-of-disk error when compiling Rust projects, so we free up some space this way.
+
+runs:
+  using: "composite"
+  steps:
+    - name: Free Disk Space
+      uses: jlumbroso/free-disk-space@54081f138730dfa15788a46383842cd2f914a1be # 1.3.1
+      with:
+        android: true # This alone is a 12 GB save.
+        # We disable the rest because it caused some problems. (they're enabled by default)
+        # The Android removal is enough.
+        dotnet: false
+        haskell: false
+        large-packages: false
+        swap-storage: false

.github/actions/macos-dependencies/action.yml

@@ -0,0 +1,14 @@
+name: Install macOS dependencies
+description: Installs dependencies required to compile the template on macOS
+
+runs:
+  using: "composite"
+  steps:
+    - run: |
+        curl https://sh.rustup.rs -sSf -y | sh
+        brew install protobuf
+        rustup default nightly-2024-08-07
+        rustup target add wasm32-unknown-unknown --toolchain nightly-2024-08-07
+        rustup component add rust-src --toolchain nightly-2024-08-07
+        rustup component add clippy --toolchain nightly-2024-08-07
+      shell: sh

.github/actions/ubuntu-dependencies/action.yml

@@ -0,0 +1,15 @@
+name: Install Ubuntu dependencies
+description: Installs dependencies required to compile the template in Ubuntu
+
+runs:
+  using: "composite"
+  steps:
+    - name: Rust compilation prerequisites (Ubuntu)
+      if: contains(matrix.os, 'ubuntu')
+      run: |
+        sudo apt update
+        sudo apt install -y \
+          protobuf-compiler
+        rustup target add wasm32-unknown-unknown
+        rustup component add rustfmt clippy rust-src
+      shell: bash

.github/workflows/ci.yml

@@ -0,0 +1,87 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - master
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    steps:
+      - uses: actions/checkout@v4
+
+      - if: contains(matrix.os, 'ubuntu')
+        uses: ./.github/actions/free-disk-space
+      - if: contains(matrix.os, 'ubuntu')
+        uses: ./.github/actions/ubuntu-dependencies
+      - if: contains(matrix.os, 'macos')
+        uses: ./.github/actions/macos-dependencies
+
+      - name: Build the template
+        run: cargo build
+        timeout-minutes: 90
+
+      - name: Run clippy
+        run: |
+          SKIP_WASM_BUILD=1 cargo clippy --all-targets --locked --workspace --quiet
+          SKIP_WASM_BUILD=1 cargo clippy --all-targets --all-features --locked --workspace --quiet
+        timeout-minutes: 30
+
+      - name: Run the tests
+        run: SKIP_WASM_BUILD=1 cargo test
+        timeout-minutes: 15
+
+      - name: Build the docs
+        run: SKIP_WASM_BUILD=1 cargo doc --workspace --no-deps
+        timeout-minutes: 15
+
+  run-node:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    steps:
+      - uses: actions/checkout@v4
+
+      - if: contains(matrix.os, 'ubuntu')
+        uses: ./.github/actions/free-disk-space
+      - if: contains(matrix.os, 'ubuntu')
+        uses: ./.github/actions/ubuntu-dependencies
+      - if: contains(matrix.os, 'macos')
+        uses: ./.github/actions/macos-dependencies
+
+      - name: Build the node individually in release mode
+        run: cargo build --package educhain-node --release
+        timeout-minutes: 90
+
+      # This test only makes sure the node got successfully built
+      # and can be executed without issues.
+      # A test including a relaychain will be done separately.
+      - name: Check that the node starts up
+        run: |
+          ./target/release/educhain-node --dev 2>&1 | tee out.txt &
+          until curl -s '127.0.0.1:9944'; do sleep 5; done
+          until cat out.txt | grep -s "💤 Idle"; do sleep 5; done
+        shell: bash
+        timeout-minutes: 5
+
+  build-docker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ./.github/actions/free-disk-space
+
+      - name: Build the Dockerfile
+        run: docker build . -t polkadot-sdk-parachain-template
+        timeout-minutes: 90

.github/workflows/pr-reminder.yml

@@ -0,0 +1,24 @@
+name: PR Reminder
+
+permissions:
+  pull-requests: write
+
+on:
+  pull_request:
+    types:
+      - opened
+
+jobs:
+  pr-reminder:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment a reminder on a new PR
+        uses: actions/github-script@v6
+        with:
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: 'Hello, this is an automatic reminder that any code changes should be made to [the source](https://github.com/paritytech/polkadot-sdk/tree/master/templates/parachain).'
+            })