Deployment Guidelines :mag_right:

Portal uses GitHub action to deploy the portal on staging server.

Environment setup for auto deployment

Staging Deployment setup

Staging builds are configured using GitHub Actions. The file .github/workflows/deploy-staging.yml contains the commands to deploy the portal. Production builds happen when code is pushed to master branch.

To set up the deployment workflow, follow the steps below.

1. Generate an SSH key pair.

    ssh-keygen -f `staging.pem`
   

2. It will ask you the passphrase. Keep it empty.
3. Once the keys are created, update the key permissions.

    chmod 400 staging.pem
   

4. Use the commands below to get the Public key and Private key content. These values will be used later.

    ssh-keygen -y -f staging.pem  # to get the public key content
    vi staging.pem  # to get the private key content
   

5. Log in to the staging server as the root user.
6. Make a new user using the following commands (works for Ubuntu/Debian):

    # sudo
    sudo su
   
    # add user named `githubaction` without password
    adduser githubaction --disabled-password
   
    # create .ssh directory for the user
    mkdir -p /home/githubaction/.ssh
   
    # create authorized_keys and enter the public key content for the user
    vim /home/githubaction/.ssh/authorized_keys
   
    # grant all permissions to user
    chown -R githubaction:githubaction .ssh/
   

7. Go to GitHub repo settings and switch to environment tab.
8. Create a new environment named staging.
9. Add the following environment variables within that environment:
10. SSH_HOST: The IP of the staging server.
11. SSH_USERNAME: The username of the staging server. If you have followed the user creation steps above, it would be githubaction.
12. SSH_PRIVATE_KEY: Paste the private key content from step 4.
13. SSH_BUILD_DIRECTORY: The directory where the project is located.

For more information, check out staging-deployment.yml.

Production Deployment setup

Production builds are configured using GitHub Actions. The file .github/workflows/deploy-staging.yml contains the commands to deploy the portal. Production builds happen when new releases are published. For example v1.1.2.

To set up the production deployment workflow, follow the same steps as staging. Make sure to update the keys and environment variables accordingly.

For more information, check out production-deployment.yml.

Deployment

Staging Deployment

Pre-requisites: You need to have permission to deploy on the staging Environment. If you don’t have the required access, please reach out to the Infra team for your deployment approval access

1. Raise the PR against the master branch.
2. Get the PR reviewed and merged into the master branch.
3. Go to Staging Deployment GitHub action
4. Approve the deployment.

Production Deployment

Pre-requisites: You need to have permission to deploy on the staging Environment. If you don’t have the required access, please reach out to the Infra team for your deployment approval access

1. Raise the PR against the release branch.
2. Get the PR reviewed and merged into the release branch.
3. Go to Production Deployment GitHub action
4. Approve the deployment.