difftreelog
Merge pull request #666 from UniqueNetwork/rapid-parallel-start-v2-docs
in: master
Rapid parallel start v2 docs
13 files changed
.github/workflows/ci-develop.ymldiffbeforeafterboth--- a/.github/workflows/ci-develop.yml
+++ b/.github/workflows/ci-develop.yml
@@ -1,51 +1,55 @@
+# Workflow which controls starts nested workflows.
name: develop
+# Triger: PR at 'develop' branch with following types of events.
on:
pull_request:
branches: [ 'develop' ]
types: [ opened, reopened, synchronize, ready_for_review, converted_to_draft ]
+#Concurency group for control execution queue over github runners.
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref }}
cancel-in-progress: true
+# List of a jobs included into Workflow.
jobs:
yarn-test-dev:
- if: github.event.pull_request.draft == false
+ if: github.event.pull_request.draft == false # Conditional check for draft per job.
uses: ./.github/workflows/dev-build-tests_v2.yml
unit-test:
- if: github.event.pull_request.draft == false
+ if: github.event.pull_request.draft == false # Conditional check for draft per job.
uses: ./.github/workflows/unit-test_v2.yml
canary:
- if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'canary')) }}
+ if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'canary')) }} # Conditional check for draft & labels per job.
uses: ./.github/workflows/canary.yml
- secrets: inherit # pass all secrets
+ secrets: inherit # pass all secrets from initial workflow to nested
xcm:
- if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'xcm')) }}
+ if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'xcm')) }} # Conditional check for draft & labels per job.
uses: ./.github/workflows/xcm.yml
- secrets: inherit # pass all secrets
+ secrets: inherit # pass all secrets from initial workflow to nested
forkless:
- if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'forkless')) }}
+ if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'forkless')) }} # Conditional check for draft & labels per job.
uses: ./.github/workflows/forkless.yml
node-only-update:
- if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'forkless')) }}
+ if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'forkless')) }} # Conditional check for draft & labels per job.
uses: ./.github/workflows/node-only-update_v2.yml
parallel_and_sequential_tests:
- if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'para')) }}
+ if: ${{ (github.event.pull_request.draft == false && contains( github.event.pull_request.labels.*.name, 'para')) }} # Conditional check for draft & labels per job.
uses: ./.github/workflows/node-only-update_v3.yml
codestyle:
- if: github.event.pull_request.draft == false
+ if: github.event.pull_request.draft == false # Conditional check for draft per job.
uses: ./.github/workflows/codestyle_v2.yml
yarn_eslint:
- if: github.event.pull_request.draft == false
+ if: github.event.pull_request.draft == false # Conditional check for draft per job.
uses: ./.github/workflows/test_codestyle_v2.yml
.github/workflows/ci-master.ymldiffbeforeafterboth--- a/.github/workflows/ci-master.yml
+++ b/.github/workflows/ci-master.yml
@@ -1,14 +1,18 @@
+# Workflow which controls starts nested workflows.
name: master
+# Triger: PR at 'master' branch with following types of events.
on:
pull_request:
branches: [ 'master' ]
types: [ opened, reopened, synchronize, ready_for_review ]
+#Concurency group for control execution queue over github runners.
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref }}
cancel-in-progress: true
+# List of a jobs included into Workflow.
jobs:
unit-test:
@@ -22,11 +26,11 @@
canary:
uses: ./.github/workflows/canary.yml
- secrets: inherit # pass all secrets
+ secrets: inherit # pass all secrets from initial workflow to nested
xcm:
uses: ./.github/workflows/xcm.yml
- secrets: inherit # pass all secrets
+ secrets: inherit # pass all secrets from initial workflow to nested
codestyle:
- uses: ./.github/workflows/codestyle_v2.yml
\ No newline at end of file
+ uses: ./.github/workflows/codestyle_v2.yml
.github/workflows/codestyle_v2.ymldiffbeforeafterboth--- a/.github/workflows/codestyle_v2.yml
+++ b/.github/workflows/codestyle_v2.yml
@@ -1,5 +1,8 @@
+# Nested workflow for checks related to formatting Rust code
+
name: cargo fmt
+# Triger: only call from main workflow(re-usable workflows)
on:
workflow_call:
.github/workflows/dev-build-tests_v2.ymldiffbeforeafterboth--- a/.github/workflows/dev-build-tests_v2.yml
+++ b/.github/workflows/dev-build-tests_v2.yml
@@ -1,8 +1,9 @@
+# Integration test in --dev mode
+# https://cryptousetech.atlassian.net/browse/CI-12
name: yarn test dev
-# Controls when the action will run.
+# Triger: only call from main workflow(re-usable workflows)
on:
- # Triggers the workflow on push or pull request events but only for the master branch
workflow_call:
@@ -101,4 +102,4 @@
run: |
docker builder prune -f -a
docker system prune -f
- docker image prune -f -a
\ No newline at end of file
+ docker image prune -f -a
.github/workflows/forkless-update-data_v2.ymldiffbeforeafterboth--- a/.github/workflows/forkless-update-data_v2.yml
+++ b/.github/workflows/forkless-update-data_v2.yml
@@ -1,11 +1,10 @@
-# Controls when the action will run.
+# Forkless update with data replication
+# https://cryptousetech.atlassian.net/browse/CI-42
+
+# Triger: only call from main workflow(re-usable workflows)
on:
workflow_call:
-
-#Define Workflow variables
-env:
- REPO_URL: ${{ github.server_url }}/${{ github.repository }}
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
@@ -163,3 +162,10 @@
- name: Stop running containers
if: always() # run this step always
run: docker-compose -f ".docker/docker-compose-forkless.yml" -f ".docker/docker-compose.${{ matrix.network }}.yml" down --volumes
+
+ - name: Remove builder cache
+ if: always() # run this step always
+ run: |
+ docker builder prune -f -a
+ docker system prune -f
+ docker image prune -f -a
.github/workflows/forkless-update-nodata_v2.ymldiffbeforeafterboth--- a/.github/workflows/forkless-update-nodata_v2.yml
+++ b/.github/workflows/forkless-update-nodata_v2.yml
@@ -1,6 +1,7 @@
+# Forkless update without data replication
+# https://cryptousetech.atlassian.net/browse/CI-41
-
-# Controls when the action will run.
+# Triger: only call from main workflow(re-usable workflows)
on:
workflow_call:
@@ -213,3 +214,10 @@
- name: Stop running containers
if: always() # run this step always
run: docker-compose -f ".docker/docker-compose-forkless.yml" -f ".docker/docker-compose.${{ matrix.network }}.yml" down
+
+ - name: Remove builder cache
+ if: always() # run this step always
+ run: |
+ docker builder prune -f -a
+ docker system prune -f
+ docker image prune -f -a
.github/workflows/forkless.ymldiffbeforeafterboth--- a/.github/workflows/forkless.yml
+++ b/.github/workflows/forkless.yml
@@ -1,3 +1,5 @@
+# Intermediate Nested Workflow for calling subworkflows as a parallel tasks.
+
name: Nesting Forkless
on:
.github/workflows/market-test_v2.ymldiffbeforeafterboth--- a/.github/workflows/market-test_v2.yml
+++ b/.github/workflows/market-test_v2.yml
@@ -1,3 +1,6 @@
+#https://cryptousetech.atlassian.net/browse/CI-37
+# Nested workflow for lunching Market e2e tests from external repository https://github.com/UniqueNetwork/market-e2e-tests
+
name: market api tests
# Controls when the action will run.
@@ -22,14 +25,8 @@
include:
- network: "opal"
features: "opal-runtime"
-# - network: "quartz"
-# features: "quartz-runtime"
-# - network: "unique"
-# features: "unique-runtime"
steps:
-
-
- name: Clean Workspace
uses: AutoModality/action-clean@v1.1.0
@@ -188,10 +185,3 @@
run: |
docker builder prune -f
docker system prune -f
-
- - name: Clean Workspace
- if: always()
- uses: AutoModality/action-clean@v1.1.0
-
-
-
.github/workflows/node-only-update_v2.ymldiffbeforeafterboth--- a/.github/workflows/node-only-update_v2.yml
+++ b/.github/workflows/node-only-update_v2.yml
@@ -1,12 +1,13 @@
+# https://cryptousetech.atlassian.net/browse/CI-85
+# Node only update with restart polkadot-launch process.
+
name: nodes-only update
-# Controls when the action will run.
+# Triger: only call from main workflow(re-usable workflows)
on:
workflow_call:
-#Define Workflow variables
-env:
- REPO_URL: ${{ github.server_url }}/${{ github.repository }}
+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
.github/workflows/node-only-update_v3.ymldiffbeforeafterboth1# Test workflow for debug parallel and sequental tests in scope of execution time reducing.2name: Parallele tests34# Triger: only call from main workflow(re-usable workflows)5on:6 workflow_call:7#Define Workflow variables89# A workflow run is made up of one or more jobs that can run sequentially or in parallel10jobs:1112 nodes-execution-matrix:1314 name: execution matrix1516 runs-on: self-hosted-ci17 outputs:18 matrix: ${{ steps.create_matrix.outputs.matrix }}1920 steps:2122 - name: Clean Workspace23 uses: AutoModality/action-clean@v1.1.02425 # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it26 - uses: actions/checkout@v327 with:28 ref: ${{ github.head_ref }} #Checking out head commit2930 - name: Read .env file31 uses: xom9ikk/dotenv@v1.0.23233 - name: Create Execution matrix34 uses: fabiocaccamo/create-matrix-action@v235 id: create_matrix36 with:37 matrix: |38 network {opal}, runtime {opal}, features {opal-runtime}, mainnet_branch {${{ env.OPAL_MAINNET_TAG }}}39 network {quartz}, runtime {quartz}, features {quartz-runtime}, mainnet_branch {${{ env.QUARTZ_MAINNET_TAG }}}40 network {unique}, runtime {unique}, features {unique-runtime}, mainnet_branch {${{ env.UNIQUE_MAINNET_TAG }}}41 42 parallel-test:43 needs: nodes-execution-matrix44 # The type of runner that the job will run on45 runs-on: [self-hosted-ci,large]46474849 timeout-minutes: 13805051 name: ${{ matrix.network }} - parallel5253 continue-on-error: true #Do not stop testing of matrix runs failed. As it decided during PR review - it required 50/50& Let's check it with false.5455 strategy:56 matrix:57 include: ${{fromJson(needs.nodes-execution-matrix.outputs.matrix)}}5859 steps:6061 - name: Clean Workspace62 uses: AutoModality/action-clean@v1.1.06364 # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it65 - uses: actions/checkout@v366 with:67 ref: ${{ github.head_ref }} #Checking out head commit6869 - name: Read .env file70 uses: xom9ikk/dotenv@v1.0.27172 - name: Generate ENV related extend file for docker-compose73 uses: cuchi/jinja2-action@v1.2.074 with:75 template: .docker/docker-compose.tmp-node.j276 output_file: .docker/docker-compose.node.${{ matrix.network }}.yml77 variables: |78 REPO_URL=${{ github.server_url }}/${{ github.repository }}.git79 RUST_TOOLCHAIN=${{ env.RUST_TOOLCHAIN }}80 POLKADOT_BUILD_BRANCH=${{ env.POLKADOT_BUILD_BRANCH }}81 POLKADOT_MAINNET_BRANCH=${{ env.POLKADOT_MAINNET_BRANCH }}82 MAINNET_TAG=${{ matrix.mainnet_tag }}83 MAINNET_BRANCH=${{ matrix.mainnet_branch }}84 FEATURE=${{ matrix.features }}85 RUNTIME=${{ matrix.runtime }}86 BRANCH=${{ github.head_ref }}87 88 - name: Show build configuration89 run: cat .docker/docker-compose.node.${{ matrix.network }}.yml9091 - name: Generate launch-config-forkless-nodata.json92 uses: cuchi/jinja2-action@v1.2.093 with:94 template: .docker/forkless-config/launch-config-node-update-only-v3.j295 output_file: .docker/launch-config-forkless-nodata.json96 variables: |97 FEATURE=${{ matrix.features }}98 RUNTIME=${{ matrix.runtime }}99 100 - name: Show launch-config-forkless configuration101 run: cat .docker/launch-config-forkless-nodata.json102103 - uses: actions/setup-node@v3104 with:105 node-version: 16106107 - name: Build the stack108 run: docker-compose -f ".docker/docker-compose-forkless.yml" -f ".docker/docker-compose.node.${{ matrix.network }}.yml" up -d --build --remove-orphans --force-recreate --timeout 300109110 # π POLKADOT LAUNCH COMPLETE π111 - name: Check if docker logs consist messages related to testing of Node Parachain Upgrade.112 if: success()113 run: |114 counter=160115 function check_container_status {116 docker inspect -f {{.State.Running}} node-parachain117 }118 function do_docker_logs {119 docker logs --details node-parachain 2>&1120 }121 function is_started {122 if [ "$(check_container_status)" == "true" ]; then123 echo "Container: node-parachain RUNNING";124 echo "Check Docker logs"125 DOCKER_LOGS=$(do_docker_logs)126 if [[ ${DOCKER_LOGS} = *"POLKADOT LAUNCH COMPLETE"* ]];then127 echo "π POLKADOT LAUNCH COMPLETE π"128 return 0129 else130 echo "Message not found in logs output, repeating..."131 return 1132 fi133 else134 echo "Container node-parachain NOT RUNNING"135 echo "Halting all future checks"136 exit 1137 fi138 echo "something goes wrong"139 exit 1140 }141 while ! is_started; do142 echo "Waiting for special message in log files "143 sleep 30s144 counter=$(( $counter - 1 ))145 echo "Counter: $counter"146 if [ "$counter" -gt "0" ]; then147 continue148 else149 break150 fi151 done152 echo "Halting script"153 exit 0154 shell: bash155156 - name: Run Parallel tests on Node Parachain157 working-directory: tests158 run: |159 yarn install160 yarn add mochawesome161 echo "Ready to start tests"162 yarn polkadot-types163 NOW=$(date +%s) && yarn testParallel --reporter mochawesome --reporter-options reportFilename=test-parallel-${NOW}164 env:165 RPC_URL: http://127.0.0.1:9933/166167 - name: Parallel Tests report168 uses: phoenix-actions/test-reporting@v8169 id: test-report-parallel170 if: success() || failure() # run this step even if previous step failed171 with:172 name: Parallel Tests report - ${{ matrix.network }} # Name of the check run which will be created173 path: tests/mochawesome-report/test-parallel-*.json # Path to test results174 reporter: mochawesome-json175 fail-on-error: 'false'176 177 178 - name: Stop running containers179 if: always() # run this step always180 run: docker-compose -f ".docker/docker-compose-forkless.yml" -f ".docker/docker-compose.node.${{ matrix.network }}.yml" down --volumes181182 - name: Remove builder cache183 if: always() # run this step always184 run: |185 docker builder prune -f -a186 docker system prune -f187 docker image prune -f -a188 189 - name: List files in Workspace190 if: always()191 run: ls -la ./192193 sequential-test:194 needs: nodes-execution-matrix195 # The type of runner that the job will run on196 runs-on: [self-hosted-ci,large]197198199200 timeout-minutes: 1380201202 name: ${{ matrix.network }} - sequential203204 continue-on-error: true #Do not stop testing of matrix runs failed. As it decided during PR review - it required 50/50& Let's check it with false.205206 strategy:207 matrix:208 include: ${{fromJson(needs.nodes-execution-matrix.outputs.matrix)}}209210 steps:211212 - name: Clean Workspace213 uses: AutoModality/action-clean@v1.1.0214215 # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it216 - uses: actions/checkout@v3217 with:218 ref: ${{ github.head_ref }} #Checking out head commit219220 - name: Read .env file221 uses: xom9ikk/dotenv@v1.0.2222223 - name: Generate ENV related extend file for docker-compose224 uses: cuchi/jinja2-action@v1.2.0225 with:226 template: .docker/docker-compose.tmp-node.j2227 output_file: .docker/docker-compose.node.${{ matrix.network }}.yml228 variables: |229 REPO_URL=${{ github.server_url }}/${{ github.repository }}.git230 RUST_TOOLCHAIN=${{ env.RUST_TOOLCHAIN }}231 POLKADOT_BUILD_BRANCH=${{ env.POLKADOT_BUILD_BRANCH }}232 POLKADOT_MAINNET_BRANCH=${{ env.POLKADOT_MAINNET_BRANCH }}233 MAINNET_TAG=${{ matrix.mainnet_tag }}234 MAINNET_BRANCH=${{ matrix.mainnet_branch }}235 FEATURE=${{ matrix.features }}236 RUNTIME=${{ matrix.runtime }}237 BRANCH=${{ github.head_ref }}238 239 - name: Show build configuration240 run: cat .docker/docker-compose.node.${{ matrix.network }}.yml241242 - name: Generate launch-config-forkless-nodata.json243 uses: cuchi/jinja2-action@v1.2.0244 with:245 template: .docker/forkless-config/launch-config-node-update-only-v3.j2246 output_file: .docker/launch-config-forkless-nodata.json247 variables: |248 FEATURE=${{ matrix.features }}249 RUNTIME=${{ matrix.runtime }}250 251 - name: Show launch-config-forkless configuration252 run: cat .docker/launch-config-forkless-nodata.json253254 - uses: actions/setup-node@v3255 with:256 node-version: 16257258 - name: Build the stack259 run: docker-compose -f ".docker/docker-compose-forkless.yml" -f ".docker/docker-compose.node.${{ matrix.network }}.yml" up -d --build --remove-orphans --force-recreate --timeout 300260261 # π POLKADOT LAUNCH COMPLETE π262 - name: Check if docker logs consist messages related to testing of Node Parachain Upgrade.263 if: success()264 run: |265 counter=160266 function check_container_status {267 docker inspect -f {{.State.Running}} node-parachain268 }269 function do_docker_logs {270 docker logs --details node-parachain 2>&1271 }272 function is_started {273 if [ "$(check_container_status)" == "true" ]; then274 echo "Container: node-parachain RUNNING";275 echo "Check Docker logs"276 DOCKER_LOGS=$(do_docker_logs)277 if [[ ${DOCKER_LOGS} = *"POLKADOT LAUNCH COMPLETE"* ]];then278 echo "π POLKADOT LAUNCH COMPLETE π"279 return 0280 else281 echo "Message not found in logs output, repeating..."282 return 1283 fi284 else285 echo "Container node-parachain NOT RUNNING"286 echo "Halting all future checks"287 exit 1288 fi289 echo "something goes wrong"290 exit 1291 }292 while ! is_started; do293 echo "Waiting for special message in log files "294 sleep 30s295 counter=$(( $counter - 1 ))296 echo "Counter: $counter"297 if [ "$counter" -gt "0" ]; then298 continue299 else300 break301 fi302 done303 echo "Halting script"304 exit 0305 shell: bash306307 - name: Run Sequential tests on Node Parachain308 working-directory: tests309 run: |310 yarn install311 yarn add mochawesome312 echo "Ready to start tests"313 yarn polkadot-types314 NOW=$(date +%s) && yarn testSequential --reporter mochawesome --reporter-options reportFilename=test-sequential-${NOW}315 env:316 RPC_URL: http://127.0.0.1:9933/317318 - name: Sequential Tests report319 uses: phoenix-actions/test-reporting@v8320 id: test-report-sequential321 if: success() || failure() # run this step even if previous step failed322 with:323 name: Parallel Tests report - ${{ matrix.network }} # Name of the check run which will be created324 path: tests/mochawesome-report/test-sequential-*.json # Path to test results325 reporter: mochawesome-json326 fail-on-error: 'false'327 328 - name: Stop running containers329 if: always() # run this step always330 run: docker-compose -f ".docker/docker-compose-forkless.yml" -f ".docker/docker-compose.node.${{ matrix.network }}.yml" down --volumes331332 - name: Remove builder cache333 if: always() # run this step always334 run: |335 docker builder prune -f -a336 docker system prune -f337 docker image prune -f -a338 339 - name: List files in Workspace340 if: always()341 run: ls -la ./.github/workflows/test_codestyle_v2.ymldiffbeforeafterboth--- a/.github/workflows/test_codestyle_v2.yml
+++ b/.github/workflows/test_codestyle_v2.yml
@@ -1,5 +1,8 @@
+# Yarn Eslint over tests
+#
name: yarn eslint
+# Triger: only call from main workflow(re-usable workflows)
on:
workflow_call:
.github/workflows/try-runtime_v2.ymldiffbeforeafterboth--- a/.github/workflows/try-runtime_v2.yml
+++ b/.github/workflows/try-runtime_v2.yml
@@ -1,3 +1,7 @@
+# Try-runtime checks
+# https://cryptousetech.atlassian.net/browse/CI-38
+
+# Triger: only call from main workflow(re-usable workflows)
on:
workflow_call:
@@ -66,3 +70,10 @@
- name: Stop running containers
if: always() # run this step always
run: docker-compose -f ".docker/docker-compose-try-runtime.yml" -f ".docker/docker-compose.try-runtime.${{ matrix.network }}.yml" down
+
+ - name: Remove builder cache
+ if: always() # run this step always
+ run: |
+ docker builder prune -f -a
+ docker system prune -f
+ docker image prune -f -a
.github/workflows/unit-test_v2.ymldiffbeforeafterboth--- a/.github/workflows/unit-test_v2.yml
+++ b/.github/workflows/unit-test_v2.yml
@@ -1,8 +1,9 @@
+# Re-Usable Workflow for lanching Unit tests
name: unit tests
# Controls when the action will run.
+# Triger: only call from main workflow(re-usable workflows)
on:
- # Triggers the workflow on push or pull request events but only for the master branch
workflow_call:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
@@ -49,3 +50,10 @@
- name: Stop running containers
if: always() # run this step always
run: docker-compose -f ".docker/docker-compose-dev.yaml" -f ".docker/docker-compose.unit.yml" down
+
+ - name: Remove builder cache
+ if: always() # run this step always
+ run: |
+ docker builder prune -f -a
+ docker system prune -f
+ docker image prune -f -a