Github Action

使用方法

触发条件

提示💡

• 参数说明

repository_dispatch

若想要触发 GitHub 外部发生的活动的工作流，可以使用 GitHub API 触发名为 repository_dispatch 的 Webhook 事件。

请求地址格式为：/repos/{owner}/{repo}/dispatches 。

const axios = require('axios');
 
const options = {
  method: 'POST',
  url: 'https://api.github.com/repos/songxingguo/songxingguo.github.io/dispatches',
  headers: {
    'content-type': 'application/json',
    Accept: 'application/vnd.github+json',
    Authorization: 'Bearer GITHUB_TOKEN'
  },
  data: {event_type: 'publish', client_payload: {slug}}
};
 
axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

• 如何将语雀文章发布到Hexo博客
• @如何远程触发 GitHub Action – 陈少文的网站

多条件触发

on:
  push:
    branches:
      - "main"
  repository_dispatch:
    types: [second_brain_sync]

workflow_dispatch : 手动触发

定时执行

on:
  schedule:
    - cron: "0 8 * * *"

• 一个简单的Github Action CI脚本,每天早上8点调用指定代码库中的接口

执行脚本

static.yml

name: 更新数字花园
on: [push]
jobs:
  garden-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: 'Checkout codes'
        uses: actions/checkout@v4
        with:
          sparse-checkout: |
            garden.sh
          sparse-checkout-cone-mode: false
      - name: "触发garden的GithubAction"
        run: bash ./garden.sh
        env:
          GH_TOKEN: ${{ secrets.GH_TOKEN }}

garden.sh

#!/bin/sh
 
set -eux
 
curl --request POST \
  --url https://api.github.com/repos/songxingguo/garden/dispatches \
  --header "Accept: application/vnd.github+json" \
  --header "Authorization: Bearer $GH_TOKEN" \
  --header 'content-type: application/json' \
  --data '
{
  "event_type":"second_brain_sync"
}'

• 如果在另一个仓库中推送，则触发 GitHub Actions。
• 当另一个仓库更新（推送、拉取请求）时触发Github Action
• @GitHub Actions 教程：定时发送天气邮件 - 阮一峰的网络日志

远程登录

• ssh-action

检出代码

• checkout

指定 node 版本

  - name: Setup Node.js
	uses: actions/setup-node@master
	with:
	  node-version: "18.13.0"

推送代码

推送到其他仓库

 - name: Push to another repository
	uses: cpina/github-action-push-to-another-repository@main
	env:
	  API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
	with:
	  source-directory: 'dist'   // 要提交的目标文件
	  destination-github-username:  ${{ secrets.STORE_USER_NAME }}
	  destination-repository-name: ${{ secrets.STORE_ANOTHER_NAME }}
	  user-email: ${{ secrets.USER_EMAIL }}
	  target-branch: master  // 目标分支

• Github实现push触发自动构建（包括提交代码到另一个仓库中和发布npm）

部署博客

name: GitHub Actions Build and Deploy
on:
  push:
    branches:
      - main
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v3
        with:
          persist-credentials: false   
          
      - name: Setup Node.js
        uses: actions/setup-node@master
        with:
          node-version: "18.13.0"
 
      - name: Install and Build 🔧
        run: |
          npm i --force
          npm run build
      - name: 推送到代码仓库
        env:
          GH_TOKEN: ${{ secrets.GH_TOKEN }}
          GH_REF: "github.com/songxingguo/brain.git"
          CO_TOKEN: ${{ secrets.CO_TOKEN }}
          CO_REF: "e.coding.net/songxingguo/songxingguo.coding.me/brain.git"
        run: |
          cd ./src/.vuepress/dist
          git init
          git config user.name "songxingguo"
          git config user.email "1328989942@qq.com"
          git add .
          git commit -m "Update Blog By GithubAction With Build $TRAVIS_BUILD_NUMBER"
          # Github Pages
          git push --force --quiet "https://${GH_TOKEN}@${GH_REF}" master:gh-pages
          # Coding Pages
          git push --force --quiet "https://zrUWsPQJyF:${CO_TOKEN}@${CO_REF}" master:master

部署 Docker

• 【【github actions自动部署docker项目】】

GitHub Actions

• Github静态博客部署到 Coding
• github-action-deploy

IP 地址

• GitHub Actions 服务器的 IP 范围
• GitHub 的 IP 地址
• “将 CIDR 转换为 IPv4”站点
• CIDR 表示法

docker

常见问题

Action 写入权限

denied: permission_denied: The token provided does not match expected scopes.

和下面的

• Unable to push to ghcr.io from Github Actions 
• raise ghcr unexpected status: 403 Forbidden when push ghcr image

常用示例

同步代码到Gitee

name: Sync Github Repos To Gitee
on:
    push:
        branches:
            - master
jobs:
    repo-sync:
        runs-on: ubuntu-latest
        steps:
            - name: Sync Github Repos To Gitee
              uses: Yikun/hub-mirror-action@master
              with:
                  src: github/bilibili-ayang
                  dst: gitee/bilibili-ayang
                  dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}
                  dst_token: ${{ secrets.GITEE_TOKEN }}
                  static_list: "HTML-CSS-case"
                  force_update: true

参考资料

• GitHub Actions 入门教程
• @GitHub Actions 手动触发方式进化史 - P3TERX ZONE
• @使用GithubActions自动化工作流 - 黄思喆的博客 _ Hsz’s Blog
• 玩转 GitHub Actions
• Github Actions总结