Github Actions 记录

Table of contents

Docker镜像构建通用Actions脚本

创建.github/workflows/build-image.yml内容如下：

name: Build and Push Docker Image

on:
  push:
    branches: [ main ]
  workflow_dispatch: # 支持手动点击按钮构建

env:
  REGISTRY: ghcr.io
  IMAGE_NAME: ${{ github.repository }}

jobs:
  build-and-push:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write # 必须赋予写入 Packages 的权限

    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Log in to the Container registry
        uses: docker/login-action@v4
        with:
          registry: ${{ env.REGISTRY }}
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}

      - name: Extract metadata (tags, labels) for Docker
        id: meta
        uses: docker/metadata-action@v6
        with:
          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
          tags: |
            type=raw,value=latest

      - name: Build and push Docker image
        uses: docker/build-push-action@v6
        with:
          context: . # 指定根目录的Dockerfile
          push: true
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}

这样每次push之后都会自动构建根目录下的Dockerfile并形成ghcr.io的镜像。

自动更新pnpm的Lockfile

添加.github/workflows/update-lockfile.yml如下：

name: Auto Update pnpm Lockfile

on:
  push:
    branches:
      - main # 如果你的默认分支是 master，请改为 master
    paths:
      - 'package.json' # 只有当 package.json 改变时才触发
  workflow_dispatch:

permissions:
  contents: write # 必须赋予写权限，否则无法推代码

jobs:
  update-lockfile:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install Node.js
        uses: actions/setup-node@v6.4.0

      - name: Install pnpm
        uses: pnpm/action-setup@v6.0.8
        with:
          run_install: false

      - name: Update Lockfile
        run: pnpm install --no-frozen-lockfile

      - name: Commit and Push changes
        run: |
          git config --global user.name "github-actions[bot]"
          git config --global user.email "github-actions[bot]@://github.com"
          
          # 检查是否有文件变动
          if [ -n "$(git status --porcelain pnpm-lock.yaml)" ]; then
            git add pnpm-lock.yaml
            git commit -m "chore: auto update pnpm-lock.yaml"
            git push
          else
            echo "Lockfile is already up to date."
          fi

这样，我们只管更新package.json（比如AstroPaper的），然后直接push就行了。彻底免除本地调试。

定期执行Actions

可以设置cron如下：

on:
  workflow_dispatch:
  schedule:
    - cron: '0 22 * * 5' # UTC+0时区下，每周五的22:00运行

Job运行于容器内

首先，声明容器：

jobs:
  build:
    runs-on: ubuntu-latest
    
    # 核心配置：指定该 Job 运行在你自定义的 Docker 容器中
    container:
      image: ghcr.io/user/repo:latest
      # 如果你的镜像是【私有】的，需要取消下方 credentials 的注释，并确保有权限读取镜像
      # credentials:
      #   username: ${{ github.actor }}
      #   password: ${{ secrets.GITHUB_TOKEN }} # 或者使用具备 read:packages 权限的个人访问令牌 (PAT)

其次，需要注意任何命令都要在Docker中存在。

向另一个仓库推送

首先，创建一个仓库PAT:

1. 在 GitHub 右上角头像 -> Settings -> Developer settings -> Personal access tokens (Fine-grained)。
2. 点击 Generate new token，给它起个名字。
3. Repository access 选择 Only select repositories，并选择你的目标仓库。
4. Permissions 中找到 Repository permissions -> 在添加的搜索框中输入 Contents 并勾选 -> 设置为 Read and write。
5. 生成令牌后复制它（它只会显示一次）。
6. 回到你当前运行 Actions 的源仓库 -> Settings -> Secrets and variables -> Actions -> 点击 New repository secret。
7. Name 填入 TARGET_REPO_PAT （或者其他名称），Secret 填入刚才复制的令牌。

然后，Actions先checkout目标仓库：

- name: Checkout Target Repo
uses: actions/checkout@v6
with:
    repository: 'user/目标仓库名'
    token: ${{ secrets.TARGET_REPO_PAT }} # 使用刚才配置的密钥
    path: 'target-repo' # 将目标仓库克隆到该子目录下

执行完操作后，最终push目标仓库：

- name: Push to Target Repo
  run: |
      # 进入目标仓库
      cd target-repo
      
      # 配置 Git 用户信息（用于提交显示）
      git config --global user.name "github-actions[bot]"
      git config --global user.email "github-actions[bot]@://github.com"
      
      # 检查是否有文件变动，防止没有变动时报错
      if [ -n "$(git status --porcelain)" ]; then
      git add .
      git commit -m "docs: sync markdown file from source repo"
      git push origin main # 推送到目标仓库的 main 分支
      else
      echo "No changes to commit"
      fi