How To Deploy A Git Repository To A Server Using GitHub Actions

Do you want to learn how to deploy a git repository to your own server using GitHub Actions? In this post, I will lead you through creating it step-by-step. This includes the steps on your server, the steps on GitHub, and the action itself. Therefore we will go through the different sections:

1. The idea and the goal
2. GitHub Action to deploy a git repository on a server
3. Conclusion
4. Helpful Links

The idea and the goal

The goal of this action is to push changes to your repository and to pull them onto your server automatically. This can be useful for deploying a website or a web app that automatically updates when the user visits/reloads your page.
To accomplish this, the idea of the action is to first connect to the server via ssh as a user with enough rights for the next steps. Then we want to change the directory to the directory containing the repository, change to the main branch, and pull the changes. Afterward, we can exit the shell again.

VPS Hosting Course

Learn everything you need to know about servers and hosting your own applications!

GitHub Action to deploy a git repository on a server

Now that we described the action’s goal and idea, we can start to set everything up. Follow the following steps:

On your server:

1. Create a new user or use your own
2. Check that user has access to the directory containing the repository (if the repository does not yet exist on the server, clone it into the directory you want)
3. Create an SSH key:
   ssh-keygen -t rsa -b 4096
4. Add the public key to the authorized_keys file:
   cat <path/to/public/key> >> ~/.ssh/authorized_keys
5. Copy content of the key file:
   cat <path/to/private/key>
6. You need to paste it in the next step.

On the GitHub website:

1. Go to “Settings > Secrets > Actions”
2. Create the following secrets:
   • SSH_PRIVATE_KEY: content of the private key file
   • SSH_USER: user to access the server
   • SSH_HOST: hostname/ip-address of your server
   • WORK_DIR: path to the directory containing the repository
   • MAIN_BRANCH: name of the main branch (mostly main)
3. Go to the “Actions” tab in your GitHub repository
4. Click on “set up a workflow yourself”
5. Paste the following content:

on:
  push:
    branches:
      - main
  workflow_dispatch:
  
jobs:
  run_pull:
    name: run pull
    runs-on: ubuntu-latest
    
    steps:
    - name: install ssh keys
      # check this thread to understand why its needed:
      # https://stackoverflow.com/a/70447517
      run: |
        install -m 600 -D /dev/null ~/.ssh/id_rsa
        echo "${{ secrets.SSH_PRIVATE_KEY }}" > ~/.ssh/id_rsa
        ssh-keyscan -H ${{ secrets.SSH_HOST }} > ~/.ssh/known_hosts
    - name: connect and pull
      run: ssh ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }} "cd ${{ secrets.WORK_DIR }} && git checkout ${{ secrets.MAIN_BRANCH }} && git pull && exit"
    - name: cleanup
      run: rm -rf ~/.ssh

The different blocks do the following:

• on: execute the action on push to the main branch or start it manually
• install ssh keys: setup ssh keys and known hosts
• connect and pull: connect to the server via ssh, go to the correct directory and branch and then pull changes
• cleanup: remove the ssh keys and known hosts again

Conclusion

In this post, we create a GitHub Action to deploy changes in a git repository to a server easily. I hope this little guide was helpful to you. In case you have any questions, feel free to ask in the comments or send me a mail at mail@programonaut.com (also check out the helpful links sections before).

In case you rather want to use Docker for your application, check out this post here, where we deploy a Docker image of our application to our own server!

If this guide is helpful to you and you like what I do, please support me with a coffee!

If you liked this post, consider subscribing to my newsletter to get monthly updates!

Helpful Links

With these links, I solved problems that occurred along the way:

1. Connect via SSH in GitHub Actions
2. GitHub “Permission denied (publickey)” on git pull (although all keys are created)
3. Bad owner or permissions on /home/<user>/.ssh/config