利用GitHub Actions进行Golang项目的自动构建

by CUNOE, May 22, 2022

这段时间刚考完试,正好提到了自动化部署,周六花了一天时间浅学了一下

思路

  1. 项目上传GitHub
  2. GitHub Actions对项目进行编译并发布到DockerHub
  3. Github Actions通过SSH连接到服务器运行Docker Compose进行部署

配置文件

Dockerfile

这次的项目仍然采用Docker进行构建

参考文件Dockerfile

# 基础镜像 第一阶段
FROM golang:1.17.8-alpine as builder

RUN apk --no-cache add git

MAINTAINER cunoe

# 操作目录
WORKDIR /go/src/cunoe/

# 复制源文件至操作目录
COPY .. .

# 编译
RUN GO111MODULE=on CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o app

# 基础镜像 第二阶段
FROM alpine:latest as prod

RUN apk --no-cache add ca-certificates

WORKDIR /root/

# 从builder复制二进制文件至操作目录
COPY --from=builder /go/src/cunoe/app .

CMD ["./app"]

这是项目里实际用到的Dockerfile,与我之前的构建不同,这次我采用的是多阶段构建,其好处就是有效的缩小了最终产生的镜像体积,同时更加便于维护与使用,你可以随时在某一阶段停下。通过这种方式构建的镜像由于只存在二进制文件,故其体积几乎只有二进制文件的大小,便于服务器进行部署。

.github/workflows/Deploy.yml

name: deploy

# 在[master]分支发生[push]和[pull_request]的操作时进行如下[jobs]
on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
# [build] 用于构建项目并且发布到DockerHub 我采用的是Docker官方提供的方案
  build:
    runs-on: ubuntu-latest

    steps:
      -
        name: Set up QEMU
        uses: docker/setup-qemu-action@v1
      -
        name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v1
      -
        name: Login to DockerHub
        uses: docker/login-action@v1 
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}
          # 通过DockerHub》Account Settings》Security》New Access Token创建
      -
        name: Build and push
        id: docker_build
        uses: docker/build-push-action@v2
        with:
          push: true
          tags: cunoe/hello:latest

# [deploy]通过SSH连接到服务器执行操作
  deploy:
    runs-on: ubuntu-latest
    needs: [build]  # 依赖于[build]
    steps:
      - name: SSH Remote Commands
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.HOST }}
          username: ${{ secrets.USERNAME }}
          port: ${{ secrets.PORT }}
          password: ${{ secrets.PASSWORD }}
          script: ${{ secrets.COMMAND }}    # 需要执行的命令

后记

如此就完成了GitHub Actions的布置

当然你可以不采用Docker官方提供的Actions,也有不错的开源Actions如:wuhan005/publish-docker-action

下面是服务器的参考命令

#!/bin/bash
docker stop cunoe-hello
docker rm cunoe-hello
docker rmi cunoe/hello
docker compose -f /home/cunoe/docker-compose.yml up -d cunoe-hello

通过Docker Compose可以很方便的去管理Docker容器