release.yml

name: Release
concurrency:
  group: ${{github.workflow}}-${{github.ref}}
  cancel-in-progress: true
on:
  push:
    tags:
      - "v[0-9]+.[0-9]+.[0-9]+" # ex. v0.29.9
      - "v[0-9]+.[0-9]+.[0-9]+-[0-9]+" # ex. v0.29.9-1
      - "v[0-9]+.[0-9]+.[0-9]+-rc[0-9]+" # ex. v0.29.9-1-rc1
      - "vX.X.X" # used for testing only
env:
  RUST_TOOLCHAIN: nightly-2022-09-22 # Update this when updating the Rust toolchain
  NEW_RELEASE_VERSION: ${{github.ref_name}}
  NEW_RELEASE_TAG: ${{github.ref_name}}
jobs:
  build-binaries:
    name: Build ${{matrix.arch}} Binary for ${{matrix.network}}
    strategy:
      matrix:
        os: [[self-hosted, Linux, X64], [self-hosted, Linux, ARM64]]
        network: [local, rococo, mainnet]
        include:
          - network: local
            spec: frequency-rococo-local
            build-profile: release
            release-file-name-prefix: frequency-local
          - network: rococo
            spec: frequency-rococo-testnet
            build-profile: production
            release-file-name-prefix: frequency-rococo
          - network: mainnet
            spec: frequency
            build-profile: production
            release-file-name-prefix: frequency
          - os: [self-hosted, Linux, X64]
            arch: amd64
          - os: [self-hosted, Linux, ARM64]
            arch: arm64
    runs-on: ${{matrix.os}}
    steps:
      - name: Set Global Env Vars
        run: |
          echo "BIN_DIR=target/${{matrix.build-profile}}" >> $GITHUB_ENV
          echo "BUILT_BIN_FILENAME=frequency" >> $GITHUB_ENV
          echo "RELEASE_BIN_FILENAME=${{matrix.release-file-name-prefix}}.${{matrix.arch}}" >> $GITHUB_ENV
      - name: Set Ubuntu Env Vars
        run: |
          echo "HOME=/home/ubuntu" >> $GITHUB_ENV
      - name: Install Required Packages
        run: |
          sudo apt-get update
          sudo apt install -y protobuf-compiler
      - name: Check Out Repo
        uses: actions/checkout@v3
      # # XXX Keep this step as it lets us skip full binary builds during development/testing
      # - name: Cache Binary for Testing
      #   id: cache-binary
      #   uses: actions/cache@v3
      #   with:
      #     path: ${{env.BIN_DIR}}/${{env.BUILT_BIN_FILENAME}}
      #     key: ${{runner.os}}-${{matrix.network}}-${{matrix.arch}}-${{env.NEW_RELEASE_VERSION}}
      - name: Install Rust Toolchain
        if: steps.cache-binary.outputs.cache-hit != 'true'
        uses: actions-rs/toolchain@v1
        with:
          toolchain: stable
          default: true
          profile: minimal
          target: wasm32-unknown-unknown
      - name: Cache Rust Dependencies
        if: steps.cache-binary.outputs.cache-hit != 'true'
        uses: Swatinem/rust-cache@v2
        with:
          shared-key: ${{env.RUST_TOOLCHAIN}}
      - name: Compile for ${{matrix.network}}
        if: steps.cache-binary.outputs.cache-hit != 'true'
        run: |
          CARGO_INCREMENTAL=0 RUSTFLAGS="-D warnings" cargo build \
            --locked \
            --features ${{matrix.spec}} \
            --profile ${{matrix.build-profile}}
      - name: Run Sanity Checks
        run: |
          file ${{env.BIN_DIR}}/${{env.BUILT_BIN_FILENAME}} && \
            ${{env.BIN_DIR}}/${{env.BUILT_BIN_FILENAME}} --version
      - name: Rename Binary
        run: |
          cp -p ${{env.BIN_DIR}}/${{env.BUILT_BIN_FILENAME}} \
            ${{env.BIN_DIR}}/${{env.RELEASE_BIN_FILENAME}}
      - name: Generate Binary Hash
        working-directory: ${{env.BIN_DIR}}
        run: sha256sum ${{env.RELEASE_BIN_FILENAME}} > ${{env.RELEASE_BIN_FILENAME}}.sha256
      - name: Import GPG key
        id: import-gpg
        # Pinning it to the exact version since this touches our private key
        uses: crazy-max/ghaction-import-gpg@v5.2.0
        with:
          gpg_private_key: ${{secrets.FREQUENCY_PGP_SECRET_SUBKEYS}}
          passphrase: ${{secrets.FREQUENCY_PGP_MASTER_KEY_PASSWORD}}
          fingerprint: B6327D1474C6392032870E8EFA4FD1E73A0FE707 # signing subkey
      - name: Generate Binary Signature
        working-directory: ${{env.BIN_DIR}}
        run: gpg --detach-sign --armor ${{env.RELEASE_BIN_FILENAME}}
      - name: Verify Binary
        working-directory: ${{env.BIN_DIR}}
        run: gpg --verify ${{env.RELEASE_BIN_FILENAME}}.asc
      - name: Upload Artifacts
        uses: actions/upload-artifact@v3
        with:
          name: artifacts-${{github.run_id}}
          path: |
            ${{env.BIN_DIR}}/${{env.RELEASE_BIN_FILENAME}}
            ${{env.BIN_DIR}}/${{env.RELEASE_BIN_FILENAME}}.sha256
            ${{env.BIN_DIR}}/${{env.RELEASE_BIN_FILENAME}}.asc
          if-no-files-found: error

  build-runtimes:
    name: Build Runtime for ${{matrix.network}}
    strategy:
      matrix:
        network: [rococo, mainnet]
        include:
          - network: rococo
            build-profile: production
            package: frequency-runtime
            runtime-dir: runtime/frequency
            built-wasm-file-name-prefix: frequency_runtime
            release-wasm-file-name-prefix: frequency-rococo_runtime
            features: frequency-rococo-testnet
          - network: mainnet
            build-profile: production
            package: frequency-runtime
            runtime-dir: runtime/frequency
            built-wasm-file-name-prefix: frequency_runtime
            release-wasm-file-name-prefix: frequency_runtime
            features: frequency
    runs-on: [self-hosted, Linux, X64]
    steps:
      - name: Set Ubuntu Env Vars
        run: |
          echo "HOME=/home/ubuntu" >> $GITHUB_ENV
      - name: Install Required Packages
        run: |
          sudo apt-get update
          sudo apt install -y protobuf-compiler
      - name: Check Out Repo
        uses: actions/checkout@v3
      - name: Install Rust Toolchain
        uses: actions-rs/toolchain@v1
        with:
          default: true
          profile: minimal
          toolchain: stable
      - name: Install Docker
        run: |
          curl -fsSL https://get.docker.com -o get-docker.sh
          sudo sh get-docker.sh
      - name: Prune Docker Resources
        run: |
          docker system prune -a --volumes -f
          docker container prune -f
          docker image prune -a -f
          docker container ls
          docker image ls
      - name: Extract Runtime Spec Version
        run: |
          echo "RUNTIME_SPEC_VERSION=$(sed -nr 's/spec_version:\s*([0-9]+),/\1/p' \
            ${{matrix.runtime-dir}}/src/lib.rs | tr -d '[:space:]')" >> $GITHUB_ENV
      - name: Validate Extracted Version
        run: |
          echo "Runtime Spec Version:|${{env.RUNTIME_SPEC_VERSION}}|"
          echo "Runtime Spec Version:||$RUNTIME_SPEC_VERSION||"
          [[ $RUNTIME_SPEC_VERSION == ?(-)+([0-9]) ]] || \
            (echo "ERROR: \"${{env.RUNTIME_SPEC_VERSION}}\" is not a valid integer" && exit 10)
      - name: Set Env Vars
        run: |
          echo "WASM_DIR=${{matrix.runtime-dir}}/target/srtool/${{matrix.build-profile}}/wbuild/${{matrix.package}}" >> $GITHUB_ENV
          echo "BUILT_WASM_FILENAME=${{matrix.built-wasm-file-name-prefix}}.compact.compressed.wasm" >> $GITHUB_ENV
          echo "RELEASE_WASM_FILENAME=${{matrix.release-wasm-file-name-prefix}}-v${{env.RUNTIME_SPEC_VERSION}}.${{env.NEW_RELEASE_VERSION}}.compact.compressed.wasm" >> $GITHUB_ENV
      # # XXX Keep this step as it lets us skip WASM builds during development/testing
      # - name: Cache WASM for Testing
      #   id: cache-wasm
      #   uses: actions/cache@v3
      #   with:
      #     path: ${{env.WASM_DIR}}/${{env.BUILT_WASM_FILENAME}}
      #     key: ${{runner.os}}-${{matrix.network}}-${{env.NEW_RELEASE_VERSION}}
      - name: Install srtool-cli
        run: |
          cargo install --git https://github.com/chevdor/srtool-cli
          srtool --version
      - name: Build Deterministic WASM
        run: |
          set -ex
          srtool build \
            --default-features="on-chain-release-build,no-metadata-docs,${{matrix.features}}" \
            --profile=${{matrix.build-profile}} \
            --package=${{matrix.package}} \
            --root
      - name: Rename WASM file
        run: |
          cp -p ./${{env.WASM_DIR}}/${{env.BUILT_WASM_FILENAME}} \
            ./${{env.WASM_DIR}}/${{env.RELEASE_WASM_FILENAME}}
      - name: Upload Artifact
        uses: actions/upload-artifact@v3
        with:
          name: artifacts-${{github.run_id}}
          path: ${{env.WASM_DIR}}/${{env.RELEASE_WASM_FILENAME}}
          if-no-files-found: error

  build-rust-developer-docs:
    name: Build Rust Developer Docs
    runs-on: [self-hosted, Linux, X64]
    steps:
      - name: Set Ubuntu Env Vars
        run: echo "HOME=/home/ubuntu" >> $GITHUB_ENV
      - name: Install Required Packages
        run: |
          sudo apt-get update
          sudo apt install -y protobuf-compiler
      - name: Check Out Repo
        uses: actions/checkout@v3
      - name: Install Rust Toolchain
        uses: actions-rs/toolchain@v1
        with:
          toolchain: stable
          default: true
          profile: minimal
          target: wasm32-unknown-unknown
      - name: Cache Rust Dependencies
        uses: Swatinem/rust-cache@v2
        with:
          shared-key: ${{env.RUST_TOOLCHAIN}}
      - name: Build Docs
        run: |
          RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo doc --no-deps
      - name: Upload Docs
        uses: actions/upload-artifact@v3
        with:
          name: rust-developer-docs-${{github.run_id}}
          path: ./target/doc
          if-no-files-found: error

  build-js-api-augment:
    needs: build-binaries
    name: Build JS API Augment
    strategy:
      matrix:
        os: [ubuntu-20.04]
        network: [mainnet]
        include:
          - network: mainnet
            spec: frequency
            build-profile: production
          - os: ubuntu-20.04
            arch: amd64
    runs-on: ${{matrix.os}}
    steps:
      - name: Set Env Vars
        run: |
          echo "BIN_DIR=target/${{matrix.build-profile}}" >> $GITHUB_ENV
          echo "RELEASE_BIN_FILENAME=frequency-${{matrix.network}}.${{matrix.arch}}" >> $GITHUB_ENV
      - name: Check Out Repo
        uses: actions/checkout@v3
      - name: Set up NodeJs
        uses: actions/setup-node@v3
        with:
          node-version: 16
          cache: "npm"
          registry-url: "https://registry.npmjs.org"
          cache-dependency-path: js/api-augment/package-lock.json
      - name: Install
        run: npm install # DO NOT use `npm ci` as we want the latest polkadot/api possible
        working-directory: js/api-augment
      - name: Download Binary Artifacts
        id: download
        uses: actions/download-artifact@v3
        with:
          name: artifacts-${{github.run_id}}
          path: .
      - name: Move Binary to Target Dir
        run: |
          mkdir -p ${{env.BIN_DIR}}
          mv ${{env.RELEASE_BIN_FILENAME}} ${{env.BIN_DIR}}
          chmod 755 ${{env.BIN_DIR}}/${{env.RELEASE_BIN_FILENAME}}
      - name: Output Metadata
        run: ${{env.BIN_DIR}}/${{env.RELEASE_BIN_FILENAME}} export-metadata ./js/api-augment/metadata.json
      - name: Build
        run: npm run build
        working-directory: js/api-augment
      - name: Upload Dist Dir
        uses: actions/upload-artifact@v3
        with:
          name: js-api-augment-${{github.run_id}}
          path: js/api-augment/dist
          if-no-files-found: error

  wait-for-all-builds:
    needs: [build-binaries, build-runtimes, build-rust-developer-docs, build-js-api-augment]
    name: Wait for All Builds to Finish
    runs-on: ubuntu-20.04
    steps:
      - name: Proceed Forward
        run: echo "All build jobs have finished, proceeding with the release"

  release-artifacts:
    needs: wait-for-all-builds
    name: Release Built Artifacts
    runs-on: ubuntu-20.04
    steps:
      - name: Check Out Repo
        uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Full Release?
        run: |
          is_full_release=$([[ "$NEW_RELEASE_VERSION" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]] && \
            echo 'true' || echo 'false')
          echo "is_full_release: $is_full_release"
          echo "IS_FULL_RELEASE=$is_full_release" >> $GITHUB_ENV
      - name: Get Latest Release Tag
        run: |
          git show-ref --tags -d
          latest_tag_commit=$(git show-ref --tags -d | grep latest^{} | cut -d' ' -f1)
          latest_release_tag=$(git show-ref --tags -d | grep "^$latest_tag_commit" | \
            grep refs/tags/v | sed -e 's,.* refs/tags/,,' -e 's/\^{}//')
          echo "latest_release_tag: $latest_release_tag"
          echo "PREVIOUS_RELEASE_TAG=$latest_release_tag" >> $GITHUB_ENV
      - name: Install Tera CLI
        if: steps.cache-tera.outputs.cache-hit != 'true'
        run: |
          cargo install --git https://github.com/chevdor/tera-cli
          tera --version
      - name: Build Changelog
        id: build-changelog
        uses: mikepenz/release-changelog-builder-action@v3
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
        with:
          fromTag: ${{env.PREVIOUS_RELEASE_TAG}}
          toTag: ${{env.NEW_RELEASE_TAG}}
          configurationJson: |
            {
              "template": "#{{UNCATEGORIZED}}",
              "pr_template": "- #{{TITLE}} ##{{NUMBER}}",
              "empty_template": "- No changes",
              "transformers": [
                {
                  "pattern": "- (.*)",
                  "target": "- $1|n|"
                }
              ]
            }
      - name: Sanitize Changelog
        id: sanitize-changelog
        run: |
          echo "original: ${{steps.build-changelog.outputs.changelog}}"
          echo "1---------------------"
          changelog='${{steps.build-changelog.outputs.changelog}}'
          clean="${changelog//[\`\[\]$'\n']/}"
          echo "sanitized: $clean"
          echo "2---------------------"
          echo "sanitized=$clean" >> $GITHUB_OUTPUT
      - name: Generate Release Notes
        working-directory: tools/ci/release-notes
        run: |
          ./build-release-notes.sh '${{steps.sanitize-changelog.outputs.sanitized}}' > \
          release-notes.md
      - name: Download Binary Artifacts
        id: download
        uses: actions/download-artifact@v3
        with:
          name: artifacts-${{github.run_id}}
          path: /tmp
      - name: List Downloaded Artifacts
        run: |
          ls -la /tmp/frequency*.*
      - name: Publish Release on GitHub
        uses: softprops/action-gh-release@v1
        with:
          body_path: tools/ci/release-notes/release-notes.md
          files: /tmp/frequency*.*
      - name: Update latest tag
        if: env.IS_FULL_RELEASE == 'true'
        uses: rickstaa/action-create-tag@v1
        with:
          tag: "latest"
          force_push_tag: true
          message: "Latest full release"

  release-node-images:
    needs: wait-for-all-builds
    name: Release ${{matrix.arch}} Node Docker Image for ${{matrix.network}}
    strategy:
      matrix:
        arch: [amd64]
        network: [rococo, mainnet]
        include:
          - network: rococo
            build-profile: production
          - network: mainnet
            build-profile: production
          - arch: amd64
            docker-platform: linux/amd64
    env:
      DOCKER_HUB_PROFILE: frequencychain
      IMAGE_NAME: parachain-node
    runs-on: ubuntu-20.04
    steps:
      - name: Set Env Vars
        run: |
          echo "BIN_DIR=target/${{matrix.build-profile}}" >> $GITHUB_ENV
          echo "BUILT_BIN_FILENAME=frequency" >> $GITHUB_ENV
          echo "RELEASE_BIN_FILENAME=frequency-${{matrix.network}}.${{matrix.arch}}" >> $GITHUB_ENV
      - name: Check Out Repo
        uses: actions/checkout@v3
      - name: Download Binary Artifacts
        id: download
        uses: actions/download-artifact@v3
        with:
          name: artifacts-${{github.run_id}}
          path: .
      - name: Move Binary to Target Dir
        run: |
          mkdir -p ${{env.BIN_DIR}}
          mv ${{env.RELEASE_BIN_FILENAME}} ${{env.BIN_DIR}}/${{env.BUILT_BIN_FILENAME}}
          chmod +x ${{env.BIN_DIR}}/${{env.BUILT_BIN_FILENAME}}
      - name: Set up QEMU
        uses: docker/setup-qemu-action@v2
        with:
          platforms: ${{matrix.arch}}
      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v2
      - name: Login to DockerHub
        uses: docker/login-action@v2
        with:
          username: ${{secrets.DOCKERHUB_USERNAME_FC}}
          password: ${{secrets.DOCKERHUB_TOKEN_FC}}
      - name: Build and Push Parachain Image
        uses: docker/build-push-action@v3
        with:
          context: .
          platforms: ${{matrix.docker-platform}}
          push: true
          file: ./docker/${{env.IMAGE_NAME}}.dockerfile
          tags: |
            ${{env.DOCKER_HUB_PROFILE}}/${{env.IMAGE_NAME}}-${{matrix.network}}:${{env.NEW_RELEASE_VERSION}}
            ${{env.DOCKER_HUB_PROFILE}}/${{env.IMAGE_NAME}}-${{matrix.network}}:latest
      - name: Update DockerHub Description
        uses: peter-evans/dockerhub-description@v3
        with:
          username: ${{secrets.DOCKERHUB_USERNAME_FC}}
          password: ${{secrets.DOCKERHUB_TOKEN_FC}}
          repository: ${{env.DOCKER_HUB_PROFILE}}/${{env.IMAGE_NAME}}-${{matrix.network}}
          readme-filepath: docker/${{env.IMAGE_NAME}}-${{matrix.network}}.overview.md

  release-dev-images:
    needs: wait-for-all-builds
    name: Release Dev Docker Image for ${{matrix.node}}
    strategy:
      matrix:
        network: [local]
        arch: [amd64]
        node: [collator-node-local, instant-seal-node]
        include:
          - network: local
            build-profile: release
          - arch: amd64
            docker-platform: linux/amd64
    env:
      DOCKER_HUB_PROFILE: frequencychain
    runs-on: ubuntu-20.04
    steps:
      - name: Set Env Vars
        run: |
          echo "BIN_DIR=target/${{matrix.build-profile}}" >> $GITHUB_ENV
          echo "BUILT_BIN_FILENAME=frequency" >> $GITHUB_ENV
          echo "RELEASE_BIN_FILENAME=frequency-${{matrix.network}}.${{matrix.arch}}" >> $GITHUB_ENV
      - name: Check Out Repo
        uses: actions/checkout@v3
      - name: Download Binary Artifacts
        id: download
        uses: actions/download-artifact@v3
        with:
          name: artifacts-${{github.run_id}}
          path: .
      - name: Move Binary to Target Dir
        run: |
          mkdir -p ${{env.BIN_DIR}}
          mv ${{env.RELEASE_BIN_FILENAME}} ${{env.BIN_DIR}}/${{env.BUILT_BIN_FILENAME}}
          chmod +x ${{env.BIN_DIR}}/${{env.BUILT_BIN_FILENAME}}
      - name: Set up QEMU
        uses: docker/setup-qemu-action@v2
        with:
          platforms: ${{matrix.arch}}
      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v2
      - name: Login to DockerHub
        uses: docker/login-action@v2
        with:
          username: ${{secrets.DOCKERHUB_USERNAME_FC}}
          password: ${{secrets.DOCKERHUB_TOKEN_FC}}
      - name: Build and Push Dev Image
        uses: docker/build-push-action@v3
        with:
          context: .
          platforms: ${{matrix.docker-platform}}
          push: true
          file: ./docker/${{matrix.node}}.dockerfile
          tags: |
            ${{env.DOCKER_HUB_PROFILE}}/${{matrix.node}}:${{env.NEW_RELEASE_VERSION}}
            ${{env.DOCKER_HUB_PROFILE}}/${{matrix.node}}:latest
      - name: Update DockerHub Description
        uses: peter-evans/dockerhub-description@v3
        with:
          username: ${{secrets.DOCKERHUB_USERNAME_FC}}
          password: ${{secrets.DOCKERHUB_TOKEN_FC}}
          repository: ${{env.DOCKER_HUB_PROFILE}}/${{matrix.node}}
          readme-filepath: docker/${{matrix.node}}.overview.md

  release-rust-developer-docs:
    needs: wait-for-all-builds
    name: Release Rust Developer Docs
    runs-on: ubuntu-20.04
    steps:
      - name: Check Out Repo
        uses: actions/checkout@v3
      - name: Download Docs
        id: download
        uses: actions/download-artifact@v3
        with:
          name: rust-developer-docs-${{github.run_id}}
          path: ./target/doc
      - name: Deploy Frequency docs to gh-pages
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          branch: gh-pages
          folder: ./target/doc

  release-js-api-augment:
    needs: wait-for-all-builds
    name: Release JS API Augment
    runs-on: ubuntu-20.04
    steps:
      - name: Check Out Repo
        uses: actions/checkout@v3
      - name: Set up NodeJs
        uses: actions/setup-node@v3
        with:
          node-version: 16
          cache: "npm"
          registry-url: "https://registry.npmjs.org"
          cache-dependency-path: js/api-augment/package-lock.json
      - name: Download Dist Dir
        id: download
        uses: actions/download-artifact@v3
        with:
          name: js-api-augment-${{github.run_id}}
          path: js/api-augment/dist
      - name: Version Package
        run: npm version --new-version "${{env.NEW_RELEASE_VERSION}}" --no-git-tag-version
        working-directory: js/api-augment/dist
      - name: Release on NPM @latest
        run: npm publish --tag latest --access public
        working-directory: ./js/api-augment/dist
        env:
          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}