Unify workflows (#661)

* Unify workflows

* Changing release

* Temporary fix

* use local workflows

* remove tag

* Coderabbit suggestion

* Restoring release

* Using correct secret

* Adding coderabbit suggestions

* Use unit testing

* Remove old pipeline

* Use different runner

.github/workflows/README.md

@@ -0,0 +1,26 @@
+# GitHub Workflows
+
+This document describes the GitHub workflows used in this project.
+
+## Build
+
+- Builds, Lint, Test
+- Publishes the docker images with version `x.y.z-pr.<PR_NUMBER>`
+- If the PR has attached the label `deploy_staging` it will update the docker images `staging` and will deploy the version in the staging environment
+
+## Merge PR
+
+- Publishes the docker image with `latest`
+- Publishes the docker image with `staging`
+- Deploy the tag `staging` in the staging environment
+
+## Close release
+
+This is a workflow triggered manually from Github Actions [Close Release](https://github.com/hoprnet/RPCh/actions/workflows/release.yaml). The tasks performed by this workflow include:
+
+-   Publishes the docker image with `x.y.z`
+-   Create a Github release
+-   Tag code
+-   Changelog is autogenerated by commit linear history of the release
+-   Bumps the new version
+-   Sends a Zulip notification

.github/workflows/build.yaml

@@ -0,0 +1,123 @@
+---
+name: Build
+
+on:
+    pull_request:
+        types: 
+          - opened
+          - synchronize
+          - reopened
+          - labeled
+
+concurrency:
+    group: build
+    cancel-in-progress: true
+
+jobs:
+    build:
+        name: Build
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                node-version: [18.x, 20.x, 22.x]
+
+        services:
+          # required by unit tests
+          postgres:
+            image: postgres
+            env:
+              POSTGRES_USER: postgres
+              POSTGRES_PASSWORD: postgres
+              POSTGRES_DB: postgres
+            # set health checks to wait until postgres has started
+            options: >-
+              --health-cmd pg_isready
+              --health-interval 10s
+              --health-timeout 5s
+              --health-retries 5
+            ports:
+              - 5432:5432
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Setup Node.js
+              uses: hoprnet/hopr-workflows/actions/setup-node-js@master
+              with:
+                  node-version: ${{ matrix.node-version }}
+
+            - name: Building
+              run: yarn build
+
+            - name: Linting
+              run: yarn lint:ci
+
+            - name: Formatting
+              run: yarn format:ci
+
+            - name: Review dependencies
+              # TODO: update ethers to v6 in RPCh SDK to remove the ignore-path
+              run: yarn depcheck --ignore-path="examples"
+
+            - name: Testing
+              run: yarn test
+              env:
+                DATABASE_URL: postgres://postgres:postgres@localhost:5432/postgres
+
+            # - name: Run E2E tests
+            #   run: yarn test:e2e
+
+    publish:
+        name: Publish
+        runs-on: self-hosted-hoprnet-small
+        needs: build
+        strategy:
+          matrix:
+            project:
+              - discovery-platform
+              - rpc-server
+              - availability-monitor
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Setup GCP
+              id: gcp
+              uses: hoprnet/hopr-workflows/actions/setup-gcp@master
+              with:
+                  google-credentials: ${{ secrets.GOOGLE_HOPRASSOCIATION_CREDENTIALS_REGISTRY }}
+                  login-artifact-registry: 'true'
+                  install-sdk: 'true'
+
+            - name: Set up Docker Buildx
+              uses: docker/setup-buildx-action@v3
+              with:
+                  driver: kubernetes
+
+            - name: Get PR version
+              id: variables
+              run: |
+                  PR_VERSION=$(jq -r '.version' apps/"${{ matrix.project }}"/package.json)-pr."${{ github.event.pull_request.number }}"
+                  echo "PR_VERSION=${PR_VERSION}" >> $GITHUB_OUTPUT
+
+            - name: Build and push docker image
+              uses: docker/build-push-action@v6
+              with:
+                  push: true
+                  file: "./apps/${{ matrix.project }}/Dockerfile"
+                  tags: ${{ vars.DOCKER_IMAGE_REGISTRY }}/${{ matrix.project }}:${{ steps.variables.outputs.PR_VERSION }}
+
+            - name: Tag staging
+              if: contains(github.event.pull_request.labels.*.name, 'deploy_staging') || github.event.label.name == 'deploy_staging' && github.event.action == 'labeled'
+              run: |
+                gcloud artifacts docker tags add ${{ vars.DOCKER_IMAGE_REGISTRY }}/${{ matrix.project }}:${{ steps.variables.outputs.PR_VERSION }} ${{ vars.DOCKER_IMAGE_REGISTRY }}/${{ matrix.project }}:staging
+
+    deploy:
+      name: Deploy
+      needs: publish
+      if: contains(github.event.pull_request.labels.*.name, 'deploy_staging') || github.event.label.name == 'deploy_staging' && github.event.action == 'labeled'
+      uses: ./.github/workflows/deploy.yaml
+      with:
+        branch: ${{ github.event.pull_request.head.ref }}
+      secrets: inherit

.github/workflows/deploy.yaml

@@ -0,0 +1,38 @@
+---
+name: Deploy
+
+on:
+  workflow_call:
+    inputs:
+      branch:
+        required: true
+        type: string
+
+concurrency:
+    group: deploy
+    cancel-in-progress: true
+
+jobs:
+
+    deploy:
+      name: Deploy staging
+      runs-on: self-hosted-hoprnet-small
+      steps:
+        - name: Checkout repository
+          uses: actions/checkout@v4
+          with:
+            ref: ${{ inputs.branch }}
+
+        - name: Setup GCP
+          id: gcp
+          uses: hoprnet/hopr-workflows/actions/setup-gcp@master
+          with:
+            google-credentials: ${{ secrets.GCP_SA_TERRAFORM_JSON_STAGING }}
+            project: hopr-staging
+            login-gke: 'true'
+
+        - name: "Restart deployment"
+          run: |
+              echo "[INFO] Restarting degen deployment"
+              kubectl rollout restart deployments -n uhttp availability-monitor discovery-platform
+              kubectl rollout status -w deployments -n uhttp availability-monitor discovery-platform

.github/workflows/merge.yaml

@@ -0,0 +1,57 @@
+name: Merge PR
+
+on:
+    pull_request:
+        types:
+            - closed
+        branches:
+            - main
+
+concurrency:
+    group: merge
+    cancel-in-progress: false
+
+jobs:
+    merge:
+        name: Merge PR
+        runs-on: self-hosted-hoprnet-small
+        if: github.event.pull_request.merged == true
+        strategy:
+          matrix:
+            project:
+              - discovery-platform
+              - rpc-server
+              - availability-monitor
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Setup GCP
+              id: gcp
+              uses: hoprnet/hopr-workflows/actions/setup-gcp@master
+              with:
+                  google-credentials: ${{ secrets.GOOGLE_HOPRASSOCIATION_CREDENTIALS_REGISTRY }}
+                  login-artifact-registry: 'true'
+
+            - name: Set up Docker Buildx
+              uses: docker/setup-buildx-action@v3
+              with:
+                  driver: kubernetes
+
+            - name: Build and push docker image
+              uses: docker/build-push-action@v6
+              with:
+                  push: true
+                  file: "./apps/${{ matrix.project }}/Dockerfile"
+                  tags: |
+                    ${{ vars.DOCKER_IMAGE_REGISTRY }}/${{ matrix.project }}:staging
+                    ${{ vars.DOCKER_IMAGE_REGISTRY }}/${{ matrix.project }}:latest
+
+    deploy:
+      name: Deploy staging
+      needs: merge
+      uses: ./.github/workflows/deploy.yaml
+      with:
+        branch: ${{ github.event.pull_request.head.ref }}
+      secrets: inherit

.github/workflows/release.yaml

@@ -0,0 +1,110 @@
+name: Close release
+
+on:
+    workflow_dispatch:
+        inputs:
+            release_type:
+                description: 'Next version type'
+                required: true
+                type: choice
+                default: 'patch'
+                options:
+                    - patch
+                    - minor
+                    - major
+            project:
+                description: 'Project'
+                required: true
+                type: choice
+                options:
+                    - discovery-platform
+                    - rpc-server
+                    - availability-monitor
+
+concurrency:
+    group: release
+    cancel-in-progress: false
+
+jobs:
+    release:
+        name: Close release
+        runs-on: self-hosted-hoprnet-small
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Setup Node.js
+              uses: hoprnet/hopr-workflows/actions/setup-node-js@master
+              with:
+                  node-version: ${{ vars.NODE_VERSION }}
+
+            - name: Setup GCP
+              id: gcp
+              uses: hoprnet/hopr-workflows/actions/setup-gcp@master
+              with:
+                  google-credentials: ${{ secrets.GOOGLE_HOPRASSOCIATION_CREDENTIALS_REGISTRY }}
+                  login-artifact-registry: 'true'
+
+            - name: Set up Docker Buildx
+              uses: docker/setup-buildx-action@v3
+              with:
+                  driver: kubernetes
+
+            - name: Building
+              run: yarn build
+
+            - name: Linting
+              run: yarn lint:ci
+
+            - name: Formatting
+              run: yarn format:ci
+
+            - name: Testing
+              run: yarn test
+
+            - name: Setup environment variables
+              id: environment
+              run: |
+                  PACKAGE_VERSION=$(jq -r '.version' "apps/${{ inputs.project }}/package.json")
+                  echo "release_version=${PACKAGE_VERSION}" >> $GITHUB_OUTPUT
+
+            - name: Create Release
+              uses: softprops/action-gh-release@v2
+              with:
+                  name: '${{ inputs.project }} - v${{ steps.environment.outputs.release_version }}'
+                  tag_name: v${{ steps.environment.outputs.release_version }}
+
+            - name: Build and push docker image
+              uses: docker/build-push-action@v6
+              with:
+                  push: true
+                  file: "./apps/${{ inputs.project }}/Dockerfile"
+                  tags: ${{ vars.DOCKER_IMAGE_REGISTRY }}/${{ inputs.project }}:${{ steps.environment.outputs.release_version }}
+
+            - name: Bump Version
+              id: bump
+              run: |
+                  npm version ${{ inputs.release_type }} -w "apps/${{ inputs.project }}" --no-git-tag-version
+                  BUMP_VERSION=$(jq -r '.version' "apps/${{ inputs.project }}/package.json")
+                  echo "bump_version=${BUMP_VERSION}" >> $GITHUB_OUTPUT
+
+            - uses: EndBug/add-and-commit@v9
+              with:
+                add: 'apps/${{ inputs.project}}'
+                default_author: github_actor
+                new_branch: main
+                message: 'Bump ${{ inputs.project }} version to ${{ steps.bump.outputs.bump_version }}'
+                pathspec_error_handling: exitImmediately
+
+            - name: Notify new release
+              uses: zulip/github-actions-zulip/send-message@v1
+              with:
+                  api-key: ${{ secrets.ZULIP_API_KEY }}
+                  email: ${{ secrets.ZULIP_EMAIL }}
+                  organization-url: 'https://hopr.zulipchat.com'
+                  type: 'stream'
+                  to: 'Releases'
+                  topic: 'main'
+                  content: |
+                      I'm thrilled to inform the new **${{ vars.DOCKER_IMAGE_NAME }}** version **${{ steps.environment.outputs.release_version }}** has been released.