GitHub Actions - Automatically Build and Release Binaries

_{FTC: Some links in this post are income earning affiliate links.}

Welcome to part 4 of my GitHub Actions post series. This part will cover how to build and release a binary version of Caddy from GitHub Actions. In part 1 we got our Actions pipeline up and building a Docker container for our custom Caddy server image. In Part 2 we automated that process to kick off when changes were detected in the parent Caddy image using Diun. And in part 3 we automated updating our Linode VM to pull and re-deploy our updated container image. As this post is the 4th and final part of the GitHub Actions series, make sure to check out the previous 3 parts before trying to follow along with this post!

The Environment

I will be running this series as if you were running on Windows 10/11 with Visual Studio Code installed. Now this series can also be followed fairly easily if you are running on a straight Linux setup or WSL. I am also assuming you have a general understanding of the command line interface and are somewhat familiar with Docker. If you need more help leave a comment below and I will reach out!

Pre-Requisites

You should have these items created and set up before trying to follow this post.

Have followed the previous 3 parts in this series.
- Part 1, Part 2, and Part 3.

Updating the Pipeline

First thing we need to do is to update our actions.yml file to include the binary building steps. Now this is completely up to you but I prefer to have the binary steps built before doing Docker images. This makes it easier to catch errors during the build process before accidentally pushing a broken image to your registry. Open the actions.yml file in your repo and add the following lines to it.

1
### This section defines the action ###
2

3
# Name of the action
4
name: Caddy
5

6
on:
7
  # Allows you to set off the action via a POST request to the GitHub workflow API
8
  repository_dispatch:
9
    types: caddy
10
  # Allows you to manually run the action from inside the Actions tab of the repo
11
  workflow_dispatch:
12

13
# See https://docs.github.com/en/actions/using-workflows/triggering-a-workflow for more options
14

15
### This section defines the job steps for the action ###
16
jobs:
17
  build:
18
    runs-on: ubuntu-latest
19
    steps:
20
      # ---
21
      # BINARY BUILD / RELEASE
22
      # ---
23
      # Setup Go
24
      - name: Setup Go
25
        uses: actions/setup-go@v2.1.3
26
        with:
27
          go-version: '^1.16'
28
      # Get xcaddy go module
29
      - name: Get XCADDY
30
        run: |
31
          go version
32
          go install github.com/caddyserver/xcaddy/cmd/xcaddy@latest
33
      # Check out local repo
34
      - name: Pull Local Repo
35
        uses: actions/checkout@v2
36
      # Build Binaries and set them to executable
37
      - name: Build Binaries
38
        run: |
39
          sh ./scripts/caddybuild.sh
40
          sh ./scripts/caddybuild-win64.sh
41
          chmod +x caddy
42
      # Get the new version of the binary package
43
      - name: Get Binary Version
44
        id: caddy_version
45
        run: |
46
          CADDY=$(./caddy version)
47
          vr="${CADDY}"
48
          echo "::set-output name=version::$( echo $vr | head -n1 | cut -d " " -f1 )"
49
          echo "::set-output name=tag_name::$( echo $vr | head -n1 | cut -d " " -f1 )"
50
      # Create release in repository and attach binaries
51
      - name: Create Release
52
        id: create_release
53
        uses: softprops/action-gh-release@v1
54
        with:
55
          tag_name: "${{ steps.caddy_version.outputs.tag_name }}"
56
          name: Binary Update - Caddy ${{ steps.caddy_version.outputs.version }}
57
          token: ${{ secrets.GITHUB_TOKEN }}
58
          body: |
59
            Release notes: ${{ steps.get_release_notes.outputs.html_url }}
60
          files: |
61
            caddy
62
            caddy.exe
63
      # ---
64
      # DOCKER SECTION
65
      # ---
66
      # Login to Docker Hub using repo secrets
67
      - uses: actions/checkout@v2
68
      - name: Docker Hub Login
69
        id: login_docker
70
        if: always()
71
        run: |
72
          echo ${{ secrets.DOCKER_HUB_PW }} | docker login -u ${{ secrets.DOCKER_HUB_USR }} --password-stdin
73
      # Build docker image using the Dockerfile
74
      - name: Build Docker Image
75
        id: build_docker
76
        if: success()
77
        run: |
78
          docker build -f ./Dockerfile -t ${{ secrets.DOCKER_HUB_USR }}/caddy:latest .
79
      # Push docker container to Docker Hub
80
      - name: Push Docker Image
81
        id: push_docker
82
        if: success()
83
        run: |
84
          docker push ${{ secrets.DOCKER_HUB_USR }}/caddy:latest
85
      # Deploy Docker Image update to Cloud VM
86
      - name: Deploy to VM
87
        uses: appleboy/ssh-action@master
88
        with:
89
          host: ${{ secrets.LINODEhost }}
90
          username: ${{ secrets.LINODEuser }}
91
          key: ${{ secrets.LINODEkey }}
92
          port: 22
93
          script:
94
            cd ~/caddy && docker compose down && docker compose pull && docker compose up -d

Now create a new directory called scripts in your repository root and add the following two files to it:

xcaddy build --with github.com/caddy-dns/cloudflare --with github.com/caddyserver/ntlm-transport --with github.com/sjtug/caddy2-filter --with github.com/greenpau/caddy-auth-portal --with github.com/caddyserver/transform-encoder

xcaddy build --output ./caddy.exe --with github.com/caddy-dns/cloudflare --with github.com/caddyserver/ntlm-transport --with github.com/sjtug/caddy2-filter --with github.com/greenpau/caddy-auth-portal --with github.com/caddyserver/transform-encoder

Once the files are created we can commit and push our changes to GitHub.

git add .
git commit -m "Added binary building"
git push

The next time the action runs you should see a new release on your repository with a Linux and Windows binary for Caddy.

Example of a GitHub release with Caddy binaries

As you can see in the picture above the release was created with both caddy and caddy.exe binaries attached. It also includes a zip/tar of the source code (These archives are a copy of your repository not Caddy’s!). The title was created using the version pulled from the Get Binary Version step in the actions file. I am currently working on pulling the proper changelogs over for Caddy but I’m running into some formatting issues with it. Once I get it working I’ll update this post to include the action steps.

As always if you run into any issues please reach out either via a comment down below or through the email contact!

Thanks to my good friend Stefan for helping proof this post series!

GitHub Actions - Automatically Build and Release Binaries

The Environment

Pre-Requisites

Updating the Pipeline

Affiliate Links

Comments

Related Posts

Deploying Jekyll on a Linode VM via GitHub Actions

GitHub Actions - Automatically Deploy Docker Updates to Cloud Hosts via SSH

GitHub Actions - Automating your Docker Builds with Diun