Feature: Add OntoPortal API deployment CI

.github/workflows/deploy.yml

@@ -1,85 +1,92 @@
-# Workflow for deploying ontologies_api to stage/prod systems via capistrano.
-# This workflow runs after a successeful execution of the unit test workflow and it
-# can also be triggered manually.
+# Workflow to deploy OntoPortal API to stage/prod systems
 #
 # Required github secrets:
 #
-# CONFIG_REPO - github repo containing config and customizations for the API. Format 'author/private_config_repo'
+# CONFIG_REPO - github repo containing config and customizations for API. Format 'author/private_config_repo'
 # it is used for getting capistrano deployment configuration for stages on the github actions runner and
-# PRIVATE_CONFIG_REPO env var is constructed from it which is used by capistrano on the remote servers for pulling configs.
+# PRIVATE_CONFIG_REPO env var is constructed from it which is used by capistrano on the API hosts for pulling configs.
 #
-# GH_PAT - github Personal Access Token for accessing PRIVATE_CONFIG_REPO
+# GH_PAT - github Personal Access Token for accessing private config repo
 #
-# SSH_JUMPHOST - ssh jump/proxy host though which deployments have to though if app servers are hosted on private network.
+# SSH_JUMPHOST - ssh jump/proxy host though which deployments have to though if API nodes live on private network.
+# SSH_JUMPHOST_USER - username  to use to connect to the ssh jump/proxy.
 #
-# DEPLOY_ENC_KEY - key for decrypting deploymnet ssh key residing in config/deploy_id_rsa_enc (see miloserdow/capistrano-deploy)
-# this SSH key is used for accessing jump host, UI nodes, and private github repo.
+# DEPLOY_ENC_KEY - key for decrypting deploymnet ssh key residing in config/
+# this SSH key is used for accessing jump host, API nodes, and private github repo.
 
 name: Capistrano Deployment
 # Controls when the action will run.
 on:
-  # Trigger deployment to staging after unit test action completes
-  workflow_run:
-    workflows: ["Ruby Unit Tests"]
-    types:
-      - completed
-    branches: [master, develop]
+  push:
+    branches:
+      - stage
+      - test
   # Allows running this workflow manually from the Actions tab
   workflow_dispatch:
-    branches: [master, develop]
     inputs:
       BRANCH:
-        description: 'Branch/tag to deploy'
-        default: develop
+        description: "Branch/tag to deploy"
+        options:
+          - stage
+          - test
+          - master
+        default: stage
         required: true
       environment:
-        description: 'target environment to deploy to'
+        description: "target environment to deploy to"
         type: choice
         options:
           - staging
-          - production
-        default: staging
-
+          - agroportal
+          - test
+        default: stage
 jobs:
   deploy:
     runs-on: ubuntu-latest
-    # run deployment only if "Ruby Unit Tests" workflow completes sucessefully or when manually triggered
-    if: ${{ (github.event.workflow_run.conclusion == 'success') || (github.event_name == 'workflow_dispatch') }}
     env:
-      BUNDLE_WITHOUT: default #install gems required primarily for the deployment in order to speed this workflow
+      BUNDLE_WITHOUT: default #install gems required primarely for deployment in order to speed up workflow
       PRIVATE_CONFIG_REPO: ${{ format('[email protected]:{0}.git', secrets.CONFIG_REPO) }}
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-    - name: set branch/tag and environment to deploy from inputs
-      run: |
-        # workflow_dispatch default input doesn't get set on push so we need to set defaults
-        # via shell parameter expansion
-        # https://dev.to/mrmike/github-action-handling-input-default-value-5f2g
-        USER_INPUT_BRANCH=${{ inputs.branch }}
-        echo "BRANCH=${USER_INPUT_BRANCH:-develop}" >> $GITHUB_ENV
-        USER_INPUT_ENVIRONMENT=${{ inputs.environment }}
-        echo "TARGET=${USER_INPUT_ENVIRONMENT:-staging}" >> $GITHUB_ENV
-    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-    - uses: actions/checkout@v3
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7.6 # Not needed with a .ruby-version file
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: get-deployment-config
-      uses: actions/checkout@v3
-      with:
-        repository: ${{ secrets.CONFIG_REPO }} # repository containing deployment settings
-        token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT
-        path:  deploy_config
-    - name: copy-deployment-config
-      run:  cp -r deploy_config/ontologies_api/* .
-    # add ssh hostkey so that capistrano doesn't complain
-    - name: Add jumphost's hostkey to Known Hosts
-      run: |
-        mkdir -p ~/.ssh
-        ssh-keyscan -H ${{ secrets.SSH_JUMPHOST }} > ~/.ssh/known_hosts
-      shell: bash
-    - uses: miloserdow/capistrano-deploy@master
-      with:
-        target: ${{ env.TARGET }} # which environment to deploy
-        deploy_key: ${{ secrets.DEPLOY_ENC_KEY }} # Name of the variable configured in Settings/Secrets of your github project
+      - name: set branch/tag and environment to deploy from inputs
+        run: |
+          # workflow_dispatch default input doesn't get set on push so we need to set defaults
+          # via shell parameter expansion
+          # https://dev.to/mrmike/github-action-handling-input-default-value-5f2g
+          USER_INPUT_BRANCH=${{ inputs.branch }}
+          echo "BRANCH=${USER_INPUT_BRANCH:github.head_ref:-master}" >> $GITHUB_ENV
+
+          USER_INPUT_ENVIRONMENT=${{ inputs.environment }}
+          echo "TARGET=${USER_INPUT_ENVIRONMENT:-staging}" >> $GITHUB_ENV
+
+          CONFIG_REPO=${{ secrets.CONFIG_REPO }}
+          GH_PAT=${{ secrets.GH_PAT }}
+          echo "PRIVATE_CONFIG_REPO=https://${GH_PAT}@github.com/${CONFIG_REPO}" >> $GITHUB_ENV
+
+          echo "SSH_JUMPHOST=${{ secrets.SSH_JUMPHOST }}" >> $GITHUB_ENV
+          echo "SSH_JUMPHOST_USER=${{ secrets.SSH_JUMPHOST_USER }}" >> $GITHUB_ENV
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.6 # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: get-deployment-config
+        uses: actions/checkout@v3
+        with:
+          repository: ${{ secrets.CONFIG_REPO }} # repository containing deployment settings
+          token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT
+          path: deploy_config
+      - name: copy-deployment-config
+        run: cp -r deploy_config/ontologies_api/${{ inputs.environment }}/* .
+        # add ssh hostkey so that capistrano doesn't complain
+      - name: Add jumphost's hostkey to Known Hosts
+        run: |
+          mkdir -p ~/.ssh
+          echo "${{ secrets.SSH_JUMPHOST }}"
+          ssh-keyscan -H ${{ secrets.SSH_JUMPHOST }} > ~/.ssh/known_hosts
+        shell: bash
+      - uses: miloserdow/capistrano-deploy@master
+        with:
+          target: ${{ env.TARGET }} # which environment to deploy
+          deploy_key: ${{ secrets.DEPLOY_ENC_KEY }} # Name of the variable configured in Settings/Secrets of your github project

.gitignore

@@ -36,7 +36,6 @@ config/environments/*
 !config/environments/config.rb.sample
 
 #ignore capistrano deployment
-config/deploy/*
 config/*.p12
 
 # Ignore generated test data

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 
 GIT
   remote: https://github.com/ontoportal-lirmm/goo.git
-  revision: b2a635fb1e8206e6e3010be4dbe033b47eb58481
+  revision: a95245b8c964431505ca6315907440996c59a00d
   branch: development
   specs:
     goo (0.0.2)
@@ -57,7 +57,7 @@ GIT
 
 GIT
   remote: https://github.com/ontoportal-lirmm/ontologies_linked_data.git
-  revision: a5b56a68e6dc8ecfc9db708d44350342dac38ce6
+  revision: 552fbe5faed5bb195396251066ef0e7b930939a0
   branch: development
   specs:
     ontologies_linked_data (0.0.1)
@@ -116,12 +116,12 @@ GEM
     bcrypt_pbkdf (1.1.1)
     bigdecimal (1.4.2)
     builder (3.3.0)
-    capistrano (3.19.0)
+    capistrano (3.19.1)
       airbrussh (>= 1.0.0)
       i18n
       rake (>= 10.0.0)
       sshkit (>= 1.9.0)
-    capistrano-bundler (2.1.0)
+    capistrano-bundler (2.1.1)
       capistrano (~> 3.1)
     capistrano-locally (0.3.0)
       capistrano (~> 3.0)
@@ -138,7 +138,7 @@ GEM
     dante (0.2.0)
     date (3.3.4)
     declarative (0.0.20)
-    docile (1.4.0)
+    docile (1.4.1)
     domain_name (0.6.20240107)
     ed25519 (1.3.0)
     faraday (1.10.3)
@@ -159,12 +159,12 @@ GEM
     faraday-httpclient (1.0.1)
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
-    faraday-net_http (1.0.1)
+    faraday-net_http (1.0.2)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
-    ffi (1.17.0-x86_64-linux-gnu)
+    ffi (1.17.0)
     gapic-common (0.21.1)
       faraday (>= 1.9, < 3.a)
       faraday-retry (>= 1.0, < 3.a)
@@ -178,26 +178,26 @@ GEM
     google-analytics-data (0.6.0)
       google-analytics-data-v1beta (>= 0.11, < 2.a)
       google-cloud-core (~> 1.6)
-    google-analytics-data-v1beta (0.12.0)
+    google-analytics-data-v1beta (0.13.0)
       gapic-common (>= 0.21.1, < 2.a)
       google-cloud-errors (~> 1.0)
     google-apis-analytics_v3 (0.16.0)
       google-apis-core (>= 0.15.0, < 2.a)
-    google-apis-core (0.15.0)
+    google-apis-core (0.15.1)
       addressable (~> 2.5, >= 2.5.1)
       googleauth (~> 1.9)
-      httpclient (>= 2.8.1, < 3.a)
+      httpclient (>= 2.8.3, < 3.a)
       mini_mime (~> 1.0)
+      mutex_m
       representable (~> 3.0)
       retriable (>= 2.0, < 4.a)
-      rexml
-    google-cloud-core (1.7.0)
+    google-cloud-core (1.7.1)
       google-cloud-env (>= 1.0, < 3.a)
       google-cloud-errors (~> 1.0)
     google-cloud-env (2.1.1)
       faraday (>= 1.0, < 3.a)
     google-cloud-errors (1.4.0)
-    google-protobuf (3.25.3-x86_64-linux)
+    google-protobuf (3.25.4)
     googleapis-common-protos (1.6.0)
       google-protobuf (>= 3.18, < 5.a)
       googleapis-common-protos-types (~> 1.7)
@@ -211,13 +211,13 @@ GEM
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (>= 0.16, < 2.a)
-    grpc (1.64.0-x86_64-linux)
-      google-protobuf (~> 3.25)
+    grpc (1.65.2-x86_64-linux)
+      google-protobuf (>= 3.25, < 5.0)
       googleapis-common-protos-types (~> 1.0)
     haml (5.2.2)
       temple (>= 0.8.0)
       tilt
-    hashdiff (1.1.0)
+    hashdiff (1.1.1)
     htmlentities (4.3.4)
     http-accept (1.7.0)
     http-cookie (1.0.6)
@@ -247,14 +247,15 @@ GEM
     method_source (1.1.0)
     mime-types (3.5.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2024.0604)
+    mime-types-data (3.2024.0806)
     mini_mime (1.1.5)
     minitest (4.7.5)
     minitest-stub_any_instance (1.0.3)
     mlanett-redis-lock (0.2.7)
       redis
     multi_json (1.15.0)
     multipart-post (2.4.1)
+    mutex_m (0.2.0)
     net-http-persistent (4.0.2)
       connection_pool (~> 2.2)
     net-imap (0.4.14)
@@ -272,7 +273,7 @@ GEM
       net-protocol
     net-ssh (7.2.3)
     netrc (0.11.0)
-    newrelic_rpm (9.11.0)
+    newrelic_rpm (9.12.0)
     oj (3.16.1)
     omni_logger (0.1.4)
       logger
@@ -340,7 +341,7 @@ GEM
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
     retriable (3.1.2)
-    rexml (3.3.1)
+    rexml (3.3.4)
       strscan
     rsolr (2.6.0)
       builder (>= 2.1.2)
@@ -385,7 +386,7 @@ GEM
     strscan (3.1.0)
     systemu (2.6.5)
     temple (0.10.3)
-    tilt (2.3.0)
+    tilt (2.4.0)
     timeout (0.4.1)
     trailblazer-option (0.1.2)
     tzinfo (2.0.6)