commit 9f168b0283f38e8cf1d32989df36d58324d7b3b1
from: Bradley Taunt <bt@btxx.org>
date: Fri Sep 20 14:35:43 2024 UTC

New post and testing git automatic deployment

commit - af4453f867165b7b64029a9a743189d4d4406146
commit + 9f168b0283f38e8cf1d32989df36d58324d7b3b1
blob - 4e346c5b424f4b090215ed1ebe52e8a02e53ede4 (mode 644)
blob + /dev/null
--- .build.yml
+++ /dev/null
@@ -1,22 +0,0 @@
-image: alpine/latest
-oauth: pages.sr.ht/PAGES:RW
-packages:
-- ruby
-- ruby-dev
-- go
-- hut
-environment:
-site: btxx.org
-sources:
-- https://git.sr.ht/~bt/btxx.org
-tasks:
-- install-gems: |
-    sudo gem install bundler 'kramdown:2.4.0' 'rss:0.3.0'
-- build: |
-    cd btxx.org
-    sudo make build
-- package: |
-    cd btxx.org/build
-    tar -cvz . > ../../site.tar.gz
-- upload: |
-    hut pages publish -d btxx.org site.tar.gz
blob - c09f8e22fb088468671ae83423a8b4f4751a2309
blob + b412d41190bfff5c27334549527405a26b9cb297
--- header.html
+++ header.html
@@ -7,7 +7,7 @@
 	<link rel="icon" href="data:,">
 	<title>{{TITLE}}</title>
 	<link href="/index.rss" type="application/rss+xml" rel="alternate" title="RSS feed for blog posts" />
-<style>*{box-sizing:border-box;}body{font-family:sans-serif;line-height:1.33;margin:0 auto;max-width:650px;padding:1rem;}blockquote{border-left:4px solid;padding-left:5px;}img{max-width:100%;}pre{border:1px solid;overflow:auto;padding:5px;}table{text-align:left;width:100%;}.posts,#menu{list-style:none;padding:0;}.posts li{margin-bottom:8px;}.posts li span{display:block;font-size:90%;}#menu li{display:inline-block;margin-right:8px;}figcaption{font-size:90%;}.footnotes{font-size:90%;}@font-face{font-family:'Monaspace';src:url('/public/fonts/MonaspaceKrypton-SyntaxHighlighter-Regular.woff2') format('woff2');}code{font-family:"Monaspace",monospace;background-color:#000;color:#f1f1f1;border-radius:.2rem;padding:.1rem;}pre:has(code){border:2px solid #f9f9f9;background-color:#000;color:#f1f1f1;padding:.5rem;border-radius:.5rem;}</style>
+<style>*{box-sizing:border-box;}body{font-family:sans-serif;line-height:1.33;margin:0 auto;max-width:650px;padding:1rem;}h2,h3,h4,h5,h6{margin:3rem 0 0;}blockquote{border-left:4px solid;padding-left:5px;}img{max-width:100%;}pre{border:1px solid;overflow:auto;padding:5px;}table{text-align:left;width:100%;}.posts,#menu{list-style:none;padding:0;}.posts li{margin-bottom:8px;}.posts li span{display:block;font-size:90%;}#menu li{display:inline-block;margin-right:8px;}figcaption{font-size:90%;}.footnotes{font-size:90%;}@font-face{font-family:'Monaspace';src:url('/public/fonts/MonaspaceKrypton-SyntaxHighlighter-Regular.woff2') format('woff2');}code{font-family:"Monaspace",monospace;background-color:#000;color:#f1f1f1;border-radius:.2rem;padding:.1rem;}pre:has(code){border:2px solid #f9f9f9;background-color:#000;color:#f1f1f1;padding:.5rem;border-radius:.5rem;}</style>
 </head>
 
 <nav id="top">
blob - /dev/null
blob + 093788f267c967bf2b1e639c32f782b42caa8e3a (mode 644)
--- /dev/null
+++ posts/git-auto-deploy.md
@@ -0,0 +1,121 @@
+# Build and Deploy Websites Automatically with Git
+
+2024-09-19
+
+I recently began the process of setting up my self-hosted[^1] `cgit` server as my main code forge. Updating repos via [cgit on NearlyFreeSpeech](/wiki/cgit/) on its own has been simple enough, but it lacked the "wow-factor" of having some sort of automated build process. I looked into a bunch of different tools that I could add to my workflow and automate deploying changes. The problem was they all seemed to be fairly bloated or overly complex for my needs.
+
+Then I realized I could simply use `post-receive` hooks which were already built-in to `git`! You can't get more simple than that...
+
+So I thought it would be best to document my full process. These notes are more for my future self when I inevitably forget this, but hopefully others can benefit from it!
+
+## Before We Begin
+
+This "tutorial" assumes that you already have a `git` server setup. It shouldn't matter what kind of forge your using, so long as you have access to the `hooks/` directory and have the ability to write a custom `post-receive` script.
+
+For my purposes I will be running standard `git` via the web through `cgit`, hosted on NearlyFreeSpeech (FreeBSD based).
+
+## Overview
+
+Here is a quick rundown of what we plan to do:
+
+* Write a custom `post-receive` script in the repo of our choice
+* Build and deploy our project when a remote push to `master` is made
+
+Nothing crazy. Once you get the hang of things it's really simple.
+
+## Prepping Our Servers
+
+Before we get into the nitty-gritty, there are a few items we need to take care of first:
+
+1. Your main `git` repo needs `ssh` access to your web hosting (deploy) server. Make sure to add your public key and run a connection test first (before running the `post-receive` hook) in order to approve the "fingerprinting".
+2. You will need to `git clone` your main `git` repo in a private/admin area of your deploy server. In the examples below, mine is cloned under `/home/private/_deploys`
+
+**Once you do both of those tasks**, continue with the rest of the article!
+
+## The `post-receive` Script
+
+I will be using my own personal website as the main project for this example. My site is built with [wruby](https://git.btxx.org/wruby), so the build instructions are specific to that generator. If you use Jekyll or something similar, you will need to tweak those commands for your own purposes.
+
+Head into your main `git` repo (*not* the cloned one on your deploy server), navigate under the `hooks/` directory and create a new file named `post-receive` containing the following:
+
+~~~bash
+#!/bin/bash
+
+# Get the branch that was pushed
+while read oldrev newrev ref
+do
+    branch=$(echo $ref | cut -d/ -f3)
+    if [ "$branch" == "master" ]; then
+
+        echo "Deploying..."
+
+        # Build on the remote server
+        ssh user@deployserver.net << EOF
+            set -e  # Stop on any error
+            cd /home/private/_deploys/btxx.org
+            git pull origin master
+            gem install 'kramdown:2.4.0' 'rss:0.3.0'
+            make build
+            rsync -a build/* ~/public/btxx.org/
+EOF
+
+        echo "Build synced to the deployment server."
+        echo "Deployment complete."
+    fi
+done
+~~~
+
+Let's break everything down.
+
+First we check if the branch being pushed to the remote server is `master`. Only if this is true do we proceed. (Feel free to change this if your prefer something like `production` or `deploy`)
+
+~~~bash
+if [ "$branch" == "master" ]; then
+~~~
+
+Then we `ssh` into the server (ie. `deployserver.net`) which will perform the build commands and also host these built files.
+
+~~~bash
+ssh user@deployserver.net << EOF
+~~~
+
+Setting `set -e` ensures that the script stops if any errors are triggered.
+
+~~~bash
+set -e  # Stop on any error
+~~~
+
+Next, we navigate into the previously mentioned "private" directory, pull the latest changes from `master`, and run the required build commands (in this case installing gems and running `make build`)
+
+~~~bash
+cd /home/private/_deploys/btxx.org
+git pull origin master
+gem install 'kramdown:2.4.0' 'rss:0.3.0'
+make build
+~~~
+
+Finally, `rsync` is run to copy just the build directory to our public-facing site directory.
+
+~~~bash
+rsync -a build/* ~/public/btxx.org/
+~~~
+
+With that saved and finished, be sure to give this file proper permissions:
+
+~~~bash
+chmod +x post-receive
+~~~
+
+That's all there is to it!
+
+## Time to Test!
+
+Now make changes to your main `git` project and push those up into `master`. You should see the `post-receive` commands printing out into your terminal successfully. Now check out your website to see the changes. Good stuff.
+
+## Still Using sourcehut
+
+My go-to code forge was previously handled through sourcehut, which will now be used for mirroring my repos and handling mailing lists (since I don't feel like hosting something like that myself - yet!). This switch over was nothing against sourcehut itself but more of a "I want to control all aspects of my projects" mentality.
+
+I hope this was helpful and please feel free to reach out with suggestions or improvements!
+
+[^1]: By self-hosted I mean a NearlyFreeSpeech instance
\ No newline at end of file
blob - 446d83fc2da61b0b2bf99c65a6730c09c3946a98
blob + d4f49e680c81f4c1b9422a1d041793969ca85646
--- wruby.rb
+++ wruby.rb
@@ -1,9 +1,3 @@
-require 'bundler/inline'
-gemfile do
-  gem 'kramdown', '2.4.0'
-  gem 'rss', '0.3.0'
-end
-
 require 'kramdown'
 require 'fileutils'
 require 'date'