通过 Github Action 将 GitHub 上的内容部署到 VPS@代码旅行 :: 信仰永恒，无所畏惧|Do Faith No Fear

通过 Github Action 将 GitHub 上的内容部署到 VPS

之前有写过自动部署的博文，但这几年实际操作中并没有那么深度使用，这些天访问 raw.githubcontent.com 总有点问题，就想着把 directConfig 的内容部署到自己的 vps 上，正好也能复习下 GitHub Action。

需求说明

我这次要完成的自动部署是当 master 分支有 push 的时候触发 GitHub Action 将内容直接部署到 VPS 上指定的文件夹里，因为这里只是几个静态文件，所以相对而言比较简单，更复杂的下次需要用的时候再来分享。

这里的需求的解决方案有两种

在 Action 的“机器”上处理好所有的事情，最后将内容通过 scp 到 VPS 的指定目录去。（推荐）
通过 Action 登录到 VPS 上，然后在 VPS 上处理所有的事情。（不建议，不建议的原因是生产力部署服务器，不应该做“部署过程”这件事，应该是做“部署结果”这件事，比如这里要用 git clone，不应该是在 VPS 操作，如果放在 VPS 上就要安装 git 等，操作的内容越多，要配置的东西越多，这是不对的。）

操作步骤

我这里用了第一种方式。

创建 Action 的文件

在项目仓库的根目录下创建文件，比如 .github/workflows/main.yaml，将下面的内容填写进去

name: deploy directConfig

on:
  push:
    branches: [ master ] # master 分支上 push 触发部署

jobs:

  build:
    # 在 ubuntu 上构建
    runs-on: ubuntu-latest 

    steps:
     # 拉取代码
     - uses: actions/checkout@v2 

     # 检查当前目录的文件
     - name: Check the folder
       run: ls -a

     # 删除 .git 和 .github 文件夹
     - name: Remove .git and .github folder
       run: rm -rf .git .github
       
     # 检查当前目录的文件
     - name: List files before renaming
       run: ls -a

     # 创建 rules 文件夹，并将内容移动到里面
     - name: Create rules folder and move all files into it
       run: mkdir rules && mv *.list rules/

     # 检查当前目录的文件
     - name: List files before renaming
       run: ls -a
       
     # 将内容 SCP 到 VPS 服务器
     - name: SCP rules 
       uses: appleboy/scp-action@master
       with:
        host: ${{ secrets.VPS_IP }}  # VPS 的 IP
        username: ${{ secrets.VPS_USER }}  # VPS 登录用户名
        port: ${{ secrets.VPS_PORT }} # VPS 端口
        key: ${{ secrets.SSH_KEY }} # 前面创建的私钥
        source: "rules" # 要上传的内容
        target: ${{ secrets.VPS_PATH }} # SCP 到的目录

里面的内容都有注释，很好理解，其中“检查当前目录文件”的内容是可以删除的，我是用来检查和调试的。

配置 GitHub 对应的仓库

在上面的 yaml 文件中，有一些 secrets 的信息，是不应该直接写在配置文件里的，要在 GitHub 对应的仓库里设置。具体位置 Settings->Secrets and variables->Actions secrets and variables->Repository secrets。有时候 yaml 文件中也有一些变量，比如 images 的名字，那么可以写在变量里，即 Settings->Secrets and variables->Actions secrets and variables->Repository variables。

创建对应的参数，参考如下

Secret 的格式

name: VPS_IP
secret: 对应的值

变量的格式

name: 变量名
value: 变量值

这里强烈建议用 ssh key 来登录 VPS，创建 ssh key 的步骤如下

ssh-keygen -t rsa

一路下去，不要设置密码，会得到两个文件 id_rsa 和 id_rsa.pub，前面为私钥，后面为公钥。然后执行

cat /home/your_username/.ssh/id_rsa.pub >> /home/your_username/.ssh/authorized_keys
chmod 600 /home/your_username/authorized_keys

将公钥导入，并设置了权限。私钥 id_rsa 的内容就是 ssh key。此次，完成了所有的内容，当 master 分支 push 后，即可触发。

需要注意的是，有时候我们需要修改 vps 的登录方式，即 vi /etc/ssh/sshd_config，将它设置为

PasswordAuthentication no // 一般都默认为 no
RSAAuthentication yes
PubkeyAuthentication yes
AuthorizedKeysFile .ssh/authorized_keys

记得重启 sudo service sshd restart。

本文由 Bin Hua 发表于 2024-02-08 13:12:41

> 可在 Twitter/X 上评论该篇文章或在下面留言（需要有 GitHub 账号）