Publishing with git + ssh

From XPUB & Lens-Based wiki
Revision as of 15:56, 9 October 2024 by Michael Murtaugh (talk | contribs)

This recipe is to describe the steps for taking a local folder that's managed by git and using a remote server where you have ssh access, creating an "as-simple-as-possible" remote that can be pushed to (and eventually pulled from) and that is also mirrored on the same server. In other words, there's also a public working directory that automatically gets updated (via a githook) when the repo is pushed to. This recipe does not require that you use a git server like gitea, gitlab, or github. Just that you have ssh access to a server. You can combine this with also using a git server (as git repos can have multiple remotes).

The steps

  • Convert local folder into a bare repo
  • scp the bare repo to a (non-public) part of your server
  • Create the webhook in the bare repo on the server

Convert local folder into a bare repo

   git clone --bare project project.git

Converts normal folder project (that is already git-managed!), into a bare repository project.git.

A bare repo is basically only the .git folder part of a git-managed folder (it's insides if you like). You could in principle just copy this (inner) folder, but git's clone command has a bare option that does it for you. It's a good idea to name a bare repo .git to remind yourself that it's a bare git repo.

scp the bare repo to your server

Here assuming you have a folder called git in your remote home folder.

   scp -r project.git remote:git/

create the webhook on the server

Now ssh to the server and edit a post-receive githook.

   ssh server
   nano git/project.git/githooks/post-receive.sh